Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation…...

21
Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Transcript of Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation…...

Page 1: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Welcome to the Friday Lego Club

Welcome to Our Home:

Tonight… Writing Clear Documentation…

…it’s hard work.

Page 2: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Instructions are Hard

Are You Sure It’s Really Clear

Signs I love… I feel a lot more like I do now than I did when I first

got here Employees Must Wash Hands Speed Enforced from Air Remove pizza from box, place in oven. Slow Children at Play

We have no trouble understanding these …

Page 3: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Precision

But Machines Need More Specific Instructions

Tires must be round, not kind of round.

Switches should work all the time.

Windows shouldn’t break.

Welds must be perfect. Every time.

How does all this work? Clear Instructions

Page 4: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

For Example . . .

How Hard is This?

Page 5: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

What Kind of Talk is That?

Do you speak C, Java, PLC, Basic, HTML, XML?

Celse if (PWM_in5 != 0x7f)

{slide = 0;}else{slide = 127;} pwm01 = slide;PWM_in2 = (255 - PWM_in2);PWM_in3 = (255 - PWM_in3);

pwm01 = Limit_Mix(2000 + PWM_in2 + slide - 127);pwm02 = Limit_Mix(2000 + PWM_in2 - slide + 127);pwm03 = Limit_Mix(2000 - PWM_in3 + slide + 127);pwm04 = Limit_Mix(2000 - PWM_in3 - slide + 383);

pwm05 = PWM_in11; //Wheels on frountpwm06 = 255 - PWM_in9; //bar lifting arm (Rreversed)pwm07 = PWM_in8; //ball lifting arm

Page 6: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

What Kind of Talk is That?

Do you speak C, Java, PLC, Basic, HTML, XML?

HTML<table border="0" width="100%" id="table7" cellpadding="0" cellspacing="0"><tr><td class="NavH"><a href="../tbh/index.htm">Home</a></td></tr><tr><td><img border="0" src="../images/Pixels/PixelTransparent.gif" width="1" height="8"></td></tr><tr><td><a href="../tbh/story.htm"><img border="0" src="../images/tbh/Templates/TBHNavigation01.gif" width="119" height="54" id="img1" alt="The Story of the Film" onmouseout="FP_swapImgRestore()" onmouseover="FP_swapImg(1,1,/*id*/'img1',/*url*/'../images/tbh/Templates/TBHNavigation01m.gif')"></a></td></tr><tr><td><a href="../tbh/making.htm"><img border="0" src="../images/tbh/Templates/TBHNavigation02.gif" width="119" height="54" id="img2" alt="The Making of the Film" onmouseout="FP_swapImgRestore()" onmouseover="FP_swapImg(1,1,/*id*/'img2',/*url*/'../images/tbh/Templates/TBHNavigation02m.gif')"></a></td></tr>

Page 7: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

What Kind of Talk is That?

Do you speak C, Java, PLC, Basic, HTML, XML?

Java Script<script language="JavaScript"><!--function FP_preloadImgs() {//v1.0 var d=document,a=arguments; if(!d.FP_imgs) d.FP_imgs=new Array(); for(var i=0; i<a.length; i++) { d.FP_imgs[i]=new Image; d.FP_imgs[i].src=a[i]; }}

function FP_swapImgRestore() {//v1.0 var doc=document,i; if(doc.$imgSwaps) { for(i=0;i<doc.$imgSwaps.length;i++) { var elm=doc.$imgSwaps[i]; if(elm) { elm.src=elm.$src; elm.$src=null; } } doc.$imgSwaps=null; }}

function FP_swapImg() {//v1.0 var doc=document,args=arguments,elm,n; doc.$imgSwaps=new Array(); for(n=2; n<args.length; n+=2) { elm=FP_getObjectByID(args[n]); if(elm) { doc.$imgSwaps[doc.$imgSwaps.length]=elm; elm.$src=elm.src; elm.src=args[n+1]; } }}

Page 8: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

What Kind of Talk is That?

Do you speak C, Java, PLC, Basic, HTML, XML?

XML<?xml version="1.0" encoding="UTF-8" ?> - <urlset xmlns="http://www.google.com/schemas/sitemap/0.84" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xsi:schemaLocation="http://www.google.com/schemas/sitemap/0.84 http://www.google.com/schemas/sitemap/0.84/sitemap.xsd">- <url>  <loc>http://www.rodfordelegate.com/site/index.htm</loc>   <lastmod>2006-09-10T22:23:34-05:00</lastmod>   <changefreq>Weekly</changefreq>   <priority>1</priority>   </url>- <url>  <loc>http://www.rodfordelegate.com/site/about.htm</loc>   <lastmod>2006-07-16T22:11:26-05:00</lastmod>   <changefreq>monthly</changefreq>   <priority>0.5</priority>   </url>

Page 9: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Or How Do I Do this?

Writing Good Instructions is Hard Work

Page 10: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Or How Do I Do this?

Good Instructions Require Good Illustrations

Input model

Page 11: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Or How Do I Do this?

Good Instructions Requires Good Illustrations

Page 12: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Or How Do I Do this?

Good Instructions Requires Good Illustrations

Page 13: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Or this...

Good Instructions Requires Good Illustrations

Page 14: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Try It

Create an Invention and Document It

First: You’ll get two bags of identical products

Page 15: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Try It

Create an Invention and Document It

Next: You’ll get a set of blank instruction sheets

Page 16: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Try It

Your Tools…

Your Brain!

A Pencil…

Creativity….

Page 17: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Try It

Create an Invention and Document It

Next: Name Your Invention (or when you’re done)

Page 18: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Try It

Create an Invention and Document It

Next: Build your project and write out the steps. Make drawings where needed.

Put a red brick on a blue brick and turn it over…

Page 19: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Try It

Build for 30-40 minutes.After you’ve built your machine we will take your model and hide it.

You will then trade with another group.

That group will then try to build your model from your instructions.

We will then unveil the original models and compare them to what you’ve built.

Page 20: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Try It

Did you build

This?

Page 21: Welcome to the Friday Lego Club Welcome to Our Home: Tonight… Writing Clear Documentation… …it’s hard work.

Try It

Did you build

Or This?