Description
This is a book about writing manuals. It is a guide for writers who want to create manuals that are easy to read and understand. The book covers different aspects of writing manuals, such as grammar, style, target readers, and special topics. The book also includes sample documents, worksheets, and checklists to help writers work smarter and faster.
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 including: 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.