| | 1 | '''This page is still being revised, for any questions please contact help@geni.net''' |
| | 2 | |
| | 3 | == Basic outline == |
| | 4 | |
| | 5 | Draft Template: http://groups.geni.net/syseng/wiki/JOhrenSandbox/OnlineTutorialTemplate/Overview |
| | 6 | |
| | 7 | === Navigation Guide === |
| | 8 | - at the top and possibly small ones at the bottom |
| | 9 | - clickable to allow them to jump back and forth between steps |
| | 10 | - see http://www.image-maps.com/ |
| | 11 | - horizontally oriented to take up little vertical space |
| | 12 | - not too wide so it will fit on a common browser width |
| | 13 | |
| | 14 | === Overview: === |
| | 15 | - This is a must! |
| | 16 | - Show me a picture of what I am going to do (topology, block diagram) |
| | 17 | - What is this tutorial going to show me? |
| | 18 | - What knowledge am I expected to walk away with? |
| | 19 | |
| | 20 | === Prerequisites: === |
| | 21 | - What equipment/software am I expected to bring to this tutorial? |
| | 22 | - What knowledge am I expected to have/obtain before arriving? |
| | 23 | - What credentials do I need to have to do this tutorial and how do I get them? |
| | 24 | - http://groups.geni.net/syseng/wiki/JOhrenSandbox/GENICredentials |
| | 25 | |
| | 26 | |
| | 27 | === Tools: === |
| | 28 | - What tools am I going to be using? |
| | 29 | - References to guides for installing and using the tools |
| | 30 | - Starting a list here: http://groups.geni.net/syseng/wiki/JOhrenSandbox/GENITools |
| | 31 | - Try to remove some of the "magic" here. We often want to gloss over some of the tools for the sake of time.[[BR]] |
| | 32 | - Give them a place where they can get some clarification if they don't know what the tools is or what it is doing |
| | 33 | |
| | 34 | === Instructions: === |
| | 35 | - Follow the high-level experiment steps |
| | 36 | - Design/Setup |
| | 37 | - Execute |
| | 38 | - Finish |
| | 39 | - Consistent icons |
| | 40 | - [http://groups.geni.net/geni/wiki/GENIExperimenter/Tutorials/Graphics] |
| | 41 | - Add: caution, note, tip |
| | 42 | - Number/Letter the steps to allow easy reference during the tutorial |
| | 43 | - Use indentation to make the steps easy to follow (and check off along the way if printed out) |
| | 44 | - Consider using small videos |
| | 45 | - Examples: [http://emmy9.casa.umass.edu/GEC15-GIMI-Tutorial/videos/Flukes_overview.mp4] |
| | 46 | - Make it clear what the user should enter vs. what the user should see |
| | 47 | - We should chose a wiki format to use for this |
| | 48 | - Put scripts, example output in a box with a fixed width font to distinguish from instructions |
| | 49 | {{{ |
| | 50 | $ cd mydir |
| | 51 | $ ssh my.host.com |
| | 52 | }}} |
| | 53 | - Always show expected results so the experimenter can verify that they are on the right track. |
| | 54 | - Cross-reference new terms and acronyms to a glossary when possible |
| | 55 | - Include figures and screenshots as much as possible. ''A picture is worth a thousand words''. |
| | 56 | |
| | 57 | |
| | 58 | === How to get help: === |
| | 59 | - When I do this at home, who/how can I ask for help? |
| | 60 | |
| | 61 | === Resources: === |
| | 62 | - Where can I get more information? |
| | 63 | - Troubleshooting pages or FAQs |
| | 64 | - GENI Glossary? |
| | 65 | |
| | 66 | |
| | 67 | == Suggestions: == |
| | 68 | - "At Home Worksheet" [http://groups.geni.net/syseng/attachment/wiki/SwTutorial/GEC16Portal/GEC16PortalTutorialWorksheet_2.docx Example] |
| | 69 | - Info/Checkoff Sheet |
| | 70 | - Set up classroom in groups of two if you want people to pair up |
| | 71 | |
| | 72 | |
| | 73 | == Questions: == |
| | 74 | - How do we get people to do the pre-work? |
| | 75 | - How to deal with people who come in late? |
