How_To . W r i t e Computer For Users Manuals Susan J. Grimm Belmont, C a l i f o r n i a Lifetime Learning P u b l i c a t i o n s (1982) 211 pages, i n c l u d i n g g l o s s a r y and index Hardcover Michael Willoughby N R Corporation C Wichita, Kansas This book is one of the most practical I've seen for writing and producing manuals. It is obviously oriented towards programmers and system analysts who p r o d u c e c o m p u t e r documentation; however, i t w o u l d a l s o be good for new t e c h n i c a l writers and students in any field. The aim of the book, as s t a t e d in the Preface, is to " h e l p a l l manual w r i t e r s r e s e a r c h , p l a n , write, review, produce, and maintain successful manuals." The b o o k m e e t s t h i s aim. Because it is w r i t t e n in a c o n versational tone and is laid out well, t h e b o o k is e a s y to read. Headings, figures, and examples abound. It is divided into four parts: Before You Write, When You Write, After You W r i t e , and After the Manual Is Finished. Each of these four parts is further divided into two or more chapters, each dealing with a particular a s p e c t of c r e a t i n g t h e manual. Each c h a p t e r c o n t a i n s a s e t of s t e p s and c h e c k l i s t s f o r completing that aspect. The g l o s sary contains mostly computer-related terms, but also contains some g r a m m a t i c a l and production terms. A l t h o u g h t h e examples are computer program documentation excerpts, the principles are 24 a p p l i c a b l e t o t e c h n i c a l commun i c a t i o n in any f i e l d . Much o f the material is of the type found in an i n t r o d u c t o r y t e c h n i c a l writing course, although some of it (especially the c h a p t e r s on r e s e a r c h and manuals' maintenance) is never found in the classroom. The book consists of mostly princip i e s and c h e c k l i s t s rather" than examples; in t h a t r e s p e c t , t h e book is t r u l y a professional tool rather than a textbook. In the chapter on producing manuals, the author mentions word processing and d e s c r i b e s some g e n e r i c capabilities o f WP systems. She a l s o talks about computer-based typesetting as weli as t r a d i t i o n a l production methods, but again only mentions the generic capabilities. A complete c h a p t e r on s t y l e and punctuation is included. It s t a t e s some of t h e r e c o g n i z e d r u l e s (use a c t i v e v o i c e , d o n ' t use ~argon, and so on) w h i l e avoiding grammar terminology. SeveraI chapters are followed by a short list of references for subjects treated in the chapter. Some o f t h e s e references are expected (Strunk and White, for example) while others are somewhat outdated. The lists are not comprehensive, b u t do p r o v i d e a starting point for further reading. It is n o t a g r a m m a r b o o k , n o r is it a t y p e s e t t i n g guide, but the book does provide many useful principles, hints, and checklists. It d o e s h a v e s o m e g o o d i d e a s f o r m e t h o d s of o r g a n i z i n g and presenting material. I would recommend it highly for beginning writers and s t u d e n t s , or for experienced writers who want a practical refresher.

/lp/association-for-computing-machinery/review-of-how-to-write-computer-manuals-for-users-by-susan-j-grimm-teXYRvU8Vm