Developing Quality Technical Information: A Handbook for Writers and Editors
Prentice Hall Professional Technical Reference, 2004 - Computers - 445 pages
The book presents a much needed approach to quality technical communication and a working plan for achieving quality. The examples are excellent and are easy to use and adapt. The editorial advice is simple and clear enough for tech writers who did not major in English or journalism. It is most worthy of a text in university programs, but it is more valuable to experienced writers, editors and managers concerned with raising the quality of their publications. The main difference between this and other books is that in each of the first nine chapters, one quality characteristic is presented that you can apply to your writing project to make technical information easy to use, easy to understand and easy to find. There are checklists at the end of each chapter for review and a Quality checklist in the appendix covering all of the characteristics. The book shows original text and revision text so that you can actually browse the book and see the differences applied. This is another excellent feature that should catch a purchaser's eye.
What people are saying - Write a review
We haven't found any reviews in the usual places.
Write for the intended audience
Indicate a practical reason for information
41 other sections not shown
Other editions - View all
apply appropriate audience boilerplate text checklist clarity Click code examples color configuration consistent create dangling modifiers database define delete detail document Edit ensure errors focus fonts Global positioning system graphics grid headings help topic help users highlighting imperative mood installation interface keyword Linux lnfoDBase lnfoProduct mation menu navigation pane noun object class online help online information operating system option organization original passage paragraph primary key problems quality characteristics quality rating reference information reference topics retrievability reuse revised passage sample scenarios second revision SGML specific SQL table steps style guide style guidelines subtasks syntax table of contents task orientation task topic technical information tion twips understand update usability usability testing user's users need verb visual effectiveness visual elements window words writing