Read Me First! A Style Guide for the Computer Industry / Edition 2by Sun Technical Publications, Technical Pu Sun Technical Publications
Pub. Date: 07/16/2003
Publisher: Prentice Hall
“Clear content and consistent style are essential for the usability of any system. If you're doing something complex, describing it simply becomes that much more important. Read Me First! A Style Guide for the Computer Industry tells you how to achieve these elusive goals, and does so following its own advice: it's clear, consistent, and presents advanced topics in an actionable and approachable manner.”
Principal, Nielsen Norman Group
Author, Eyetracking Web Usability
“The third edition of Read Me First! A Style Guide for the Computer Industry has all the excellent content of the first editions and more. The new chapters provide insights to new forms of communication. They include sound advice on writing alternative text for illustrations, writing narrations for screencasts, and working with wikis to enhance and manage content contributed by the user community. The material on writing procedures is invaluable for those who are struggling with task-oriented information. If you need to understand the best practices for developing useful and usable text, start with this volume.
It brings together a wealth of knowledge that all technical communication professionals must have to succeed.”
Dr. JoAnn T. Hackos, President, Comtech Services, Inc.
The definitive reference for technical writers, editors, and documentation managers, Read Me First! A Style Guide for the Computer Industry, Third Edition, has been revised and updated to cover everything from creating screencasts and referencing web sites to writing for wikis.
This award-winning guide to creating clear, consistent andeasy-to-understand documentation covers everything from grammar and writing style to typographic and legal guidelines. The authors, who are senior editors and writers at Sun Microsystems, share their extensive experience and provide practical tips and recommendations, including guidance on hiring writers, working with illustrators, managing schedules and workflow, and more.
The third edition features new chapters on:
• Writing for wikis and encouraging wiki collaboration
• Creating screencasts, using screencast terminology, and guidelines for writing narration
• Creating alternative text for nontext elements such as screen captures, multimedia content, illustrations, and diagrams
It also includes new tables for symbol name conventions, for common anthropomorphisms, and for common idioms and colloquialisms. An updated and expanded recommended reading list suggests additional resources.
- Prentice Hall
- Publication date:
- Edition description:
- 2nd Edition
- Product dimensions:
- 6.90(w) x 9.20(h) x 0.90(d)
Table of ContentsPreface.
1. Mechanics of Writing.
2. Constructing Text.
3. Writing Style.
4. Online Writing Style.
5. Constructing Links.
6. Writing Tasks, Procedures, and Steps.
7. Writing for an International Audience.
8. Legal Guidelines.
9. Types of Technical Documents.
10. Working With an Editor.
11. Working With Illustrations.
12. Writing About Graphical User Interfaces.
13. Glossary Guidelines.
Appendix A. Developing a Publications Department.
Appendix B. Checklists and Forms.
Appendix C. Correct Usage of Terms.
Appendix D. Recommended Reading.
and post it to your social network
Most Helpful Customer Reviews
See all customer reviews >