Read Me First! A Style Guide for the Computer Industry
|
Read Me First!
A Style Guide for the Computer Industry
By
Sun Technical Publications, Moutain View, CA
Second
edition,
384
pages
ISBN
0-13-142899-3
Sample Chapter
buy now ยป

Description
|
|
|
|
Description
The must-have reference for every technical writer, editor, and documentation
manager - now fully updated!
Read Me First! is the definitive guide to creating technical
documentation that is clear, consistent, and easy to understand. Sun
Microsystems' award-winning technical writers and editors cover everything from
grammar to clarity, illustrations to workflow. This fully revised second
edition reflects dramatic changes in the production and delivery of technical
documentation. Coverage includes:
- Detailed grammar, punctuation, typographic, and legal guidelines
- Extensive guidance on creating effective step-by-step procedures
- Techniques for documenting Web applications and graphical user
interfaces
- Expert help with creating indexes and glossaries
- Extensive recommendations for using hyperlinks
- Checklists and forms for editing, tracking manuscripts, and verifying
production status
- Guidelines for using commonly confused words and terms
- Practical tips for gender-neutral writing
- Internationalization guidelines that simplify translation and improve
clarity for non-native English speakers
- Real-world help for managers: hiring writers, working with illustrators,
managing schedules and workflow, coordinating with printers, and more
- Expanded and updated recommended reading list
|
|
|
 |  |
Oracle is reviewing the Sun product roadmap and will provide guidance to customers in accordance with Oracle's standard product communication policies. Any resulting features and timing of release of such features as determined by Oracle's review of roadmaps, are at the sole discretion of Oracle. All product roadmap information, whether communicated by Sun Microsystems or by Oracle, does not represent a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. It is intended for information purposes only, and may not be incorporated into any contract.