Lightening Talk: Making Good Instructions

A lightening talk about good technical instructions for a Rails Bridge Chicago Rocketeer Roundup

Transcript

1. Making Good Instructions By Cora Hays-Magan
2. Cora @CorainChicago Github: CorainChicago
3. Instructions: • detailed information telling how something should be done, operated, or assembled.
4. 1, 2, 3...Oh please
5. What exactly are you trying to do?
6. Good Instructions Give a full picture Empower Explain
7. Here’s some research Concise and Clear Know Your Audience Add Graphical Elements Design Your Page Create a Flow Test Your Instructions from: https://en.wikibooks.org/wiki/Professional_and_Technical_Writing/Instructions
8. Example Concise and Clear Know Your Audience Add Graphical Elements Design Your Page Create a Flow Test Your Instructions
9. When instructions are lacking a. Google to a nice blog post b. Let them know, nicely c. Write your own (after you brilliantly figure it out)
11. Which one do I use???
12. Cora Hays-Magan @CorainChicago github.com/CorainChicago “Instructions are good, but good instructions are even better.”