how to write a how to

erin malone @emalone

How ToHow to write a How-To


My book

By Erin Malone and Christian Crumlish http://www.oreilly.com/pub/get/DWS

http://www.oreilly.com/pub/get/DWS


OverviewOverview Step by Step Process Writing Exercise Share


How to’s?Tutorials How-tos Instructional Design Recipes Walkthroughs Interface copy

Step-by-steps Tours Patterns Anti-Patterns Onboarding Help


Overview

Tips: • Write about something you know well. • Make the thing yourself.

Do the process yourself and document as you go. • Use the process to better solidify a process for yourself.

You know it well if you can explain it to someone else clearly. • Show, do, show, do

A How-to is essentially a recipe - for whatever - for cooking, for writing, for teaching, for coding, for making


1.Who is it for?


2. Give overview


3. What tools?


4. List out the steps

Permanent link to this comic: http://www.dearfuture.com/190/ (this image has been modified to fit horizontally)

http://www.dearfuture.com/190/


5. Drill down to sub-steps


5. & flesh out the smaller tasks


6. Show alternative steps


7. Tips


8. Pictures worth 1000 words


9. Summarize and Reinforce


10. Related & more


Summary1. Define audience 2. Give overview 3. List tools 4. Detail steps 5. and substeps 6. and any alternative steps 7. Tips 8. Pictures 9. Final Summary 10.References

How to cook pasta - by Christina Wodtke


Let’s Writeexercise

Permanent link to this comic: http://xkcd.com/1029/


Group Exercise

How to boil an egg


Group Exercise

How to create a sitemap


Exercise1. Select something you know well 2. Write / Act out 3. Swap with partner 4. Critique / Ask questions 5. Iterate

Share


Thanksemail: [email protected] (or) [email protected] twitter: @emalone linkedin: www.linkedin.com/in/erinkmalone

mailto:[email protected]

mailto:[email protected]

http://www.linkedin.com/in/erinkmalone

how to write a how to

Internet