The User Manual Manual: How to Research, Write, Test, Edit and Produce a Software Manual

by Michael Bremer

The User Manual Manual is a master's course on software manuals. It describes the grammar, style, techniques and tricks needed to write a manual the gets read. It explains how to understand and target readers, technicaly inclined or not--even if they're kids. Plus, it covers special topics dealing with rush projects, preparing for internationalization, and handling projects with multiple writers, multiple platforms and multiple bosses. The User Manual Manual is a guided tour through the entire process of creating a user manual from initial concept through writing, testing, editing and production to postmortem. It contains sample documents, worksheets and checklists to help writers work smarter and faster.

Genres: Writing

Paperback

First published September 1, 1999

Reviews

[Luna Corbden · Rating 4 out of 5]

Technical writing is just like programming. Instead of programming computers, you're programming people.

If you are a technical writer, or if your job calls for occasional technical writing, including how-tos and step-by-step instruction, this guide is for you. Read it and/or use it as a reference.