Developing Quality Technical Information: A Handbook for Writers and Editors / Edition 2
  • Developing Quality Technical Information: A Handbook for Writers and Editors / Edition 2
  • Developing Quality Technical Information: A Handbook for Writers and Editors / Edition 2

Developing Quality Technical Information: A Handbook for Writers and Editors / Edition 2

4.5 2
by Gretchen Hargis

ISBN-10: 0131477498

ISBN-13: 9780131477490

Pub. Date: 04/28/2004

Publisher: IBM Press

Writing That Works

The #1 guide to excellence in documentation--now completely updated! A systematic, proven approach to creating great documentation

  • Thoroughly revised and updated
  • More practical examples
  • More coverage of topic-based information, search, and internationalization

  • Focusing on the
  • …  See more details below


    Writing That Works

    The #1 guide to excellence in documentation--now completely updated! A systematic, proven approach to creating great documentation

    • Thoroughly revised and updated
    • More practical examples
    • More coverage of topic-based information, search, and internationalization

  • Focusing on the tasks and topics users care about most
  • Saying more with fewer words
  • Using organization and other means to deliver faster access to information
  • Presenting information in more visually inviting ways
  • Improving the effectiveness of your review process
  • Learning from example: sample text, screen captures, illustrations, tables, and much more
  • Product Details

    IBM Press
    Publication date:
    IBM Press Series--Information Management
    Edition description:
    Product dimensions:
    7.10(w) x 9.40(h) x 1.30(d)

    Table of Contents


    Is this book for you? How to use this book. Conventions used in this book. Changes in this edition.


    1. Quality technical information.

    What is quality technical information? Relationships among the quality characteristics. Order of the groups. Quality characteristics compared with elements and guidelines. Other possible quality characteristics of technical information. Using the quality characteristics to develop quality technical information. Preparing to write: understanding users, tasks, and the product. Writing and rewriting. Reviewing, testing, and evaluating technical information. Writing task, concept, and reference topics. Establishing a unit of reuse. Restructuring technical information.


    2. Task orientation.

    Write for the intended audience. Present information from the user's point of view. Indicate a practical reason for information. Relate details to a task where appropriate. Provide only a necessary amount of conceptual information in task topics. Focus on real tasks, not product functions. Use headings that reveal the tasks. Divide tasks into discrete subtasks. Provide clear, step-by-step instructions. Make each step a clear action for users to take. Group steps for usability. Clearly identify optional steps. Identify criteria at the beginning of conditional steps. In sum.

    3. Accuracy.

    Write information only when you understand it, and then verify it. Keep up with technical changes. Maintain consistency of all information about a subject. Reuse information when possible. Avoid introducing inconsistencies and eliminate those that you find. Use tools that automate checking for accuracy. Check the accuracy of references to related information. In sum.

    4. Completeness.

    Cover all topics that support users' tasks, and only those topics. Cover each topic in just as much detail as users need. Include enough information. Include only necessary information. Use patterns of information to ensure proper coverage. Repeat information only when users will benefit from it. In sum.


    5. Clarity.

    Focus on the meaning. Avoid ambiguity. Use words with a clear meaning. Avoid vague referents. Place modifiers appropriately. Avoid long strings of nouns. Write positively. Make the syntax of sentences clear. Keep elements short. Remove roundabout expressions and needless repetition. Choose direct words. Keep lists short. Write cohesively. Present similar information in a similar way. Use lists appropriately. Segment information into tables. Use technical terms only if they are necessary and appropriate. Decide whether to use a term. Use terms consistently. Define each term that is new to the intended audience. In sum.

    6. Concreteness.

    Choose examples that are appropriate for the audience and subject. Consider the level and needs of users. Use examples appropriately in conceptual, task, and reference information. Use focused, realistic, accurate, up-to-date examples. Make examples easy to find. Use visual cues to indicate where examples are. Make examples part of the user interface. Make clear where examples start and stop. Make code examples easy to adapt. Use scenarios to illustrate tasks and to provide overviews. Set the context for examples and scenarios. Relate unfamiliar information to familiar information. Use general language appropriately. In sum.

    7. Style.

    Use correct grammar. Check for sentence fragments. Correct pronoun problems. Correct dangling modifiers. Use correct and consistent spelling. Use consistent and appropriate punctuation. Write with the appropriate tone. Use an active style. Use active voice. Use the present tense. Use the appropriate mood. Follow template designs and use boilerplate text. Create and reuse templates. Use boilerplate text to ensure inclusion of necessary information. Create and follow style guidelines. Provide practical and consistent highlighting. Present list items consistently. Use unbiased language. In sum.


    8. Organization.

    Organize information into discrete topics by type. Organize tasks by order of use. Organize topics for quick retrieval. Separate contextual information from other types of information. Organize information consistently. Provide an appropriate number of subentries for each branch. Emphasize main points; subordinate secondary points. Reveal how the pieces fit together. In sum.

    9. Retrievability.

    Facilitate navigation and search. Provide a complete and consistent index. Use an appropriate level of detail in the table of contents. Provide helpful entry points. Link appropriately. Design helpful links. Ensure that a link describes the information that it links to. In similar links and cross-references, emphasize the text that is different. Minimize the effort that is needed to reach related information. Avoid redundant links. Make linked-to information easy to find in the target topic. In sum.

    10. Visual effectiveness.

    Use graphics that are meaningful and appropriate. Illustrate significant concepts. Avoid illustrating what is already visible. Choose graphics that complement the text. Use visual elements for emphasis. Emphasize the appropriate information. Ensure that your visual elements are not distracting. Use visual elements logically and consistently. Use a visually simple but distinct heading hierarchy. Maintain consistent placement of document elements. Ensure that the look and feel of multimedia presentations is consistent. Use icons and symbols consistently. Balance the number and placement of visual elements. Use visual cues to help users find what they need. Visually identify recurring alternatives or contexts. Ensure that visual cues are usable in all environments. Ensure that textual elements are legible. Use a legible typeface and size. Ensure that the text fits in the available space. Ensure that the contrast between text and background is adequate. Use color and shading discreetly and appropriately. Ensure that all users can access the information. In sum.


    11. Applying more than one quality characteristic.

    Applying quality characteristics to task information. Applying quality characteristics to conceptual information. Applying quality characteristics to reference information. Applying quality characteristics to information for an international audience. Applying quality characteristics to information on the Web351 Revising technical information.

    12. Reviewing, testing, and evaluating technical information.

    Inspecting technical information. Reading and using the information. Finding problems. Reporting problems. Testing information for usability. Prototyping. Testing outside a usability laboratory. Testing in a usability laboratory. Testing technical information. Using test tools. Using test cases. Testing the user interface. Editing and evaluating technical information. Preparing to edit. Getting an overview. Reading and editing the information. Looking for specific information. Summarizing your findings. Conferring with the writer. Reviewing the visual elements. Preparing to review. Getting an overview. Reviewing individual visual elements. Summarizing your findings. Conferring with the editor or writer or both.


    Appendix A: Quality checklist.

    Appendix B: Who checks which quality characteristics?

    Appendix C: Quality characteristics and elements.

    Looking at the quality characteristics. Looking at the elements. Resources and references. Easy to use. Easy to understand. Easy to find. Putting it all together.



    Read More

    Customer Reviews

    Average Review:

    Write a Review

    and post it to your social network


    Most Helpful Customer Reviews

    See all customer reviews >

    Developing Quality Technical Information: A Handbook for Writers and Editors 4.5 out of 5 based on 0 ratings. 2 reviews.
    Anonymous More than 1 year ago
    Guest More than 1 year ago
    Reading this new edition, I was quite impressed by the practical nature of its suggestions, which are reinforced by good choices of example texts that are then revised and improved, in accordance with those suggestions. But it struck me that there is one logical subdivision of the book, which the authors may not necessarily have intended. It cleaves well into two portions. One deals with the timeless nature of writing clear, non-fiction text; totally independent of any computers. For example, it includes Part 2 of the book, entitled 'Easy to understand', which spans 3 chapters, 'Clarity', 'Concreteness' and 'Style'. Even from the single word titles, you could guess that they are of this ilk. In contrast, the other portion of the book relates more to a computer and browser oriented presentation. Both portions are well put. But the authors and the publisher may have sold themselves short. The first portion, with minor tweaks, could be useful enough as a standalone text. But to a far broader audience than technical writers. It could be directed at the high school or undergraduate level, for a class on non-fiction writing. In my high school, we never had guidelines as cogently argued as this. I could have used it then. So perhaps could you. Thus, the pity may be that most who might benefit from the book will never chance to encounter it.