Prentice Hall

Engineering

Browse available resources for General Engineering:

Select a resource
- Resources for General Engineering Instructor Resource Center myPearsonStore

Read Me First! A Style Guide for the Computer Industry, 2/E
Sun Technical Publications, Mountain View, California

ISBN-10: 0131428993
ISBN-13: 9780131428997

Publisher: Prentice Hall
Copyright: 2003
Format: Paper; 384 pp
Published: 05/06/2003

Suggested retail price: $39.99
Buy from myPearsonStore

Request a printed exam copy
Email this page to a colleague
Prepare for the First Day of Class
Learn about customization options

READ ME FIRST! is the definitive guide to creating technical documentation that is clear, consistent, and easy to understand. Sun Microsystems' award-winning tech writers and editors cover everything from grammar to clarity, illustrations to workflow. This fully revised Second Edition reflects dramatic changes in the technology industries, with extensive new coverage of Web/online documentation, internationalization, and much more.

Preface.

1. Mechanics of Writing.

Capitalization. Contractions. Gerunds and Participles. Numbers and Numerals. Pronouns. Technical Abbreviations, Acronyms, and Units of Measurement. Punctuation.

2. Constructing Text.

Headings. Lists. Tables. Code Examples. Error Messages. Cross-References. Endnotes, Footnotes, and Bibliographies. Notes, Cautions, and Tips. Part Dividers. Typographic Conventions. Key Name Conventions.

3. Writing Style.

Why Is Style Important? Stylistic Principles. Some Basic Elements of Style. Writing for the Reader. Style That Could Offend the Reader. Common Writing Problems to Avoid. Ways to Improve Your Style.

4. Online Writing Style.

About These Guidelines. Solving Online Writing Problems. Creating an Effective Document Structure. Writing Short, Self-Contained Topics. Constructing Scannable Paragraphs, Headings, and Lists. Preserving Context in Online Documents.

5. Constructing Links.

About These Guidelines. Where to Place Links. General Linking Strategies. Guidelines for Writing Link Text.

6. Writing Tasks, Procedures, and Steps.

Understanding the Relationship Among Tasks, Procedures, and Steps. Developing Task Information. Writing Procedures. Writing Steps.

7. Writing for an International Audience.

General Guidelines for Writing for Translation. Cultural and Geographic Sensitivity. Definitions and Word Choice. Grammar and Word Usage. Numbers, Symbols, and Punctuation. Illustrations and Screen Captures.

8. Legal Guidelines.

Copyrights. Trademarks. Third-Party Web Site References. Protection of Proprietary/Confidential Information.

9. Types of Technical Documents.

What Is a Documentation Set? Documentation Plans. Document Plan. Abstracts. Structure of Manuals. Descriptions of the Manual Parts. Types of Hardware Manuals. Types of Software Manuals. Other Product Documents. Training Documents.

10. Working With an Editor.

Technical Editor's Role. Editor's Role in Producing Online Documents. Types of Editing. Edit Schedules. Document Submission. Editing Marks. Edit Style Sheet.

11. Working With Illustrations.

Working With an Illustrator. Illustration Formats, Styles, and Types. Examples of Illustrations. Placing Illustrations. Writing Captions for Illustrations. Writing Callouts for Illustrations. Creating Quality Screen Captures. Creating Leader Lines. Simplifying Online Illustrations.

12. Writing About Graphical User Interfaces.

Using GUI Terminology. Writing About Windows, Dialog Boxes, and Menus. Writing About the Web.

13. Glossary Guidelines.

Glossary Content. Terms for an International Audience. When to Include a Glossary. Writing Good Glossary Entries.

14. Indexing.

What Is an Index? Style and Format. Creating an Index. Refining and Checking an Index. Bad Page and Column Breaks. Checking the Size of the Index. Global Index. Online Index.

Appendix A. Developing a Publications Department.

Establishment of a Publications Department. Scheduling. Documentation Process. Internationalization and Localization. Online Documentation Considerations. Final Print Production. Post-Production Considerations.

Appendix B. Checklists and Forms.

Manuscript Tracking Chart. Request for Editing Form. Artwork Request Form. Technical Review Cover Letter. Authorization to Produce Document. Print Specification.

Appendix C. Correct Usage of Terms.

Appendix D. Recommended Reading.

Desktop Publishing and Document Design. Editing Standards. Graphics and Illustration. HTML and XML. Indexing. Information Mapping. Internationalization and Localization. Legal Issues. Online Help. Online Writing Style. Platform Style Guides. Printing. Project Management. Reference Works. Standard Generalized Markup Language (SGML). Typography. Usability Testing. User Interfaces. Web and Internet Publishing. Writing Standards. Writing Standards for Technical Writing.

Index.

Technical Writing [PTG: PRENTICE HALL PROFESSIONAL] (General Engineering)

The Members of Sun Technical Publications are award-winning senior editors and writers for Sun Microsystems, Inc.

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

View a Sample Chapter PDF: /samplechapter/0131428993.pdf

Promotions

Promotions

Pearson Higher Education offers special pricing when you choose to package your text with other student resources. If you're interested in creating a cost-saving package for your students, contact your Pearson Higher Education representative for pricing and ordering information.

Promotions

Pearson Higher Education offers special pricing when you choose to package your text with other student resources. If you're interested in creating a cost-saving package for your students contact your Pearson Higher Education representative.