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 am reorganizing a software manual and the process has
brought up an issue for me. Each manual I have worked on
has had three types of info a user would need: an explanation
of each menu and its items, how tos, and theoretical or
historical information. In the last manual I wrote, it was easy
to mix all three. In this current manual, the how tos tend to
use more than one menu in each process so I have set
them into another chapter. Right now, I trying to decide if
I should merge the theoretical with the menu explanations
or if that would be too confusing.
To those who write software manuals, how do you tend to
organize it (considering the types of information I presented
above)?
Melonie R. Holliman
Technical Writer
CPD Marketing
Advanced Micro Devices
