Bite Size Standards offers concise web development tutorials, tips, and tricks written by designers and developers who are passionate about web standards. More about us
Manuals made minuscule
Yeah, you know how to make it work, but what about your users?
Writing a manual is actually one of the easiest things you’re going to do, and here’s how:
Outline, Outline, Outline.
Write down an outline of each process you expect someone to perform—right down to the trivial ones. Step-by-step outlines of each action = instant manual.
No explanation needed.
Getting bogged down in why it works? They’re not going to read it cover-to-cover. Focus on the instructions, and save the explanations for your friends.
Screenshots are your friends.
If they can look at the manual, look at the screen, and see the same thing, they know they’re doing it right.
Self-reference isn’t just for modern lit.
If it’s the same process in a different place, refer back to the original process.
Commenting is closed for this article.
© Copyright 2006 Bite Size Standards and Authors