Editing Modular Documentation: Some Best Practices

Much has been said about the creation of modular documentation - from content management systems, to information architecture, to delivery forms, to the usability of modular content (content being easier to use, easier to understand, and easier to find), and so on. However, not much has been said about the editing of that content, and what the editor's role is in such an environment.

Corbin, Michelle and Yoel Strimling. WritersUA (2008). Articles>Documentation>Technical Writing>Technical Editing

Editing Your Own Documentation  

Technical writers sometimes fall into the trap of thinking that the user is stupid. I have often heard technical writers say things like 'well, if the user can't figure that out, maybe he’s in the wrong job!'

Docsymmetry (2003). Articles>Documentation>Editing>Technical Writing

Writing Shorter Manuals  

Large manuals are expensive to write, produce, and ship, and may make a product seem mare diflcult or complex than it really is. Shorter manuals can decrease telephone support calls, provide a challenge to the writer, and save time and money. With careful planning and preparation, diJjCerent writing and design techniques, and participation in product design, writers can shorten manuals and make users more willing to read them.

Sommerville, Heather M. STC Proceedings (1997). Articles>Documentation>Editing>Writing

Writing Great Documentation: You Need an Editor 

All good writers have a dirty little secret: they’re not really that good at writing. Their editors just make it seem that way. It doesn’t matter how well you’ve mastered the language; nobody, even grammar geeks, gets this stuff right on the first pass. If you really want to produce great documentation, it needs to be edited.

Kaplan-Moss, Jacob. Jacobian (2009). Articles>Documentation>Technical Writing>Technical Editing