I know the first list in that recipe should've been an unordered one. :-)
Let's take our edit hats off while we look at the recipe, shall we?
How is it different from standard recipes? Here's how:
- It assumes you are doing only this task and nothing else. There's no "Do X and keep aside" instructions (despite possibilities); there's only a linear task flow.
Lesson for techcomm: Do not introduce branches into a procedure. - It does not just list the ingredients but group them according to when they're going to be used in the process and what they're going to be used together with.
Lesson for techcomm: Grouping of logically related items aids in (i) comprehension (ii) task completion. - It does not have pictures :)
Lesson for techcomm: Use pictures only if they are essential to performing the task.
3 comments:
Good tips, may be you could elaborate little more on writing better recipe blogs. Probably you already have one?
Good advice. To take this one step further, when I write an install guide I try to write something that is linear from page one to whatever. In other words after a page is turned an installer should never need to go back.
I also try to prepare the user for what's ahead. For example, if step ten requires information that was on screen in step two, I tell the user to make a note of it.
In step two, that is.
Post a Comment