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.
Subject:Re: There's more to it than grammar From:Debbie Warren <dwarren -at- DTECHS -dot- COM> Date:Fri, 12 Mar 1999 10:37:21 -0600
Don't you think that most users pick up a user's guide to locate how to do
something or how to solve a problem? They usually have the big picture
before they purchase the equipment or software. Providing lengthy text will
only serve a few and scare away others looking for a quick answer. As you
know, visuals are good for giving the user the big picture. That's why
trainer use them to teach their students.
The introduction should explain the general purpose of the manual and the
product. You might expand and give more detail in a process manual. I've
never created a process manual. Wouldn't a flowchart be a good choice to
describe a process?
