TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
It's important to tell your readers what conventions you use in the software
and in other instructions. Will commands be shown in a different font, or
bold, or italic? Does "type" mean something different from "enter"? Also, if
there are multiple ways to do something, tell about that so that info does
not have to be repeated every time you run across that issue. Tell them
your assumptions about their knowledge level (we assume you are familiar
with the keyboard). Also, tell them where to look for detailed information.
bj in dallas
bstrode -at- descartes -dot- com
Death to extremists.