- Copyright 1993
- Dimensions: 7-3/8x9-1/4
- Pages: 448
- Edition: 1st
- ISBN-10: 0-8053-6829-9
- ISBN-13: 978-0-8053-6829-1
In How to Communicate Technical Information, you will learn how to write printed and online computer documentation that is simple, clear, interesting and user-friendly. Technical writers Jonathan Price and Henry Korman map out easy-to-follow methods and include practical tips to help you create hardware and software documentation that is accessible to both beginning and experienced end-users. How to Communicate Technical Information:
Discusses easy-to-follow and user-friendly ways of organizing information.
Demonstrates how to use the art to communicate context, multiple options and results.
Offers new ways to present both quick start options for experienced users and installation instructions.
Presents effective new methods for supplying computer-based training (CBT), including sophisticated graphic and hypertext tours, and demonstrations.
Includes information on online help that suggests methods for integrating this feature into your documentation.
Throughout the book, the authors share the techniques they present in their popular seminars as they provide straightforward and interesting ways of organizing information. Price and Korman also suggest practical methods for developing good writing styles.
Table of Contents
I. PLANNING. 1. The Project Cycle—What You Do at Each Stage. 2. Gathering Information. 3. Understanding Your Audience and Their Work. 4. Learning the Product. 5. Planning the Documentation. 6. Developing a Schedule and Estimating Costs. 7. As You Work.
II. WRITING. 8. Openers—Tables of Contents and Introductions. 9. Getting Users Started. 10. Tutorials. 11. Computer-Based Training. 12. Procedures. 13. Reference Materials. 14. Indexes and Glossaries. 15. Job Aids or Quick Reference Cards. 16. Online Help.
III. REVISING. 17. Getting feedback. 18. Rewriting Drafts. 19. Refining Your Style. 20. Updating a Manual. 21. Reviewing Someone Else's Manual. Bibliography. Index. 0805368299T04062001