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.
I'm currently documenting a major program upgrade (from DOS to 32-bit
Windows) and need to incorporate the same information types you mentioned.
I've designed the manual's structure based on my users' needs. We'll have
new users with absolutely no experience with our software or computers, and
experienced users upgrading to a markedly different program. (Many of the
experienced users have little or no experience with Windows and constitute
an additional subcategory of user.)
For brand new users, I'll write a section of how-to's that cover basic
procedures and that incorporate a lot of contextual material (your
"theoretical and historical" content). I think this will help the new user
understand both how and why they are performing a task.
For our experienced users, I'll write a section of no-nonsense how-to's on
more advanced procedures.
The third type of information you mention, menu explanations, will be
divided among two areas: 1) introductory material that covers the most
commonly needed items and provides an overview of program structure, and 2)
a reference section (in print this may be reduced to a glossary, with more
extensive information available in the online help.)
The manual will also include a "Windows 101" section and a "What's changed
from the previous version" section.
Mitchell Gibbs
Technical Writer
Advantage Software, Inc.
