Read Me First! A Style Guide for the Computer Industry / Edition 2

Paperback (Print)
Buy New
Buy New from BN.com
$36.89
Buy Used
Buy Used from BN.com
$29.99
(Save 25%)
Item is in good condition but packaging may have signs of shelf wear/aging or torn packaging.
Condition: Used – Good details
Used and New from Other Sellers
Used and New from Other Sellers
from $1.99
Usually ships in 1-2 business days
(Save 95%)
Other sellers (Paperback)
  • All (25) from $1.99   
  • New (8) from $19.03   
  • Used (17) from $1.99   

Overview

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
Read More Show Less

Editorial Reviews

From the Publisher
“The third edition of Read Me First! A Style Guide for the Computer Industry has all the excellent content of the previous editions and more. 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.

“Clear content and consistent style are essential for the usability of any system. 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.”
-—Jakob Nielsen, Principal, Nielsen Norman Group; Author, Eyetracking Web Usability

Read More Show Less

Product Details

  • ISBN-13: 9780131428997
  • Publisher: Prentice Hall
  • Publication date: 7/16/2003
  • Edition description: 2nd Edition
  • Edition number: 2
  • Pages: 384
  • Product dimensions: 7.00 (w) x 8.97 (h) x 0.94 (d)

Meet the Author

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

Read More Show Less

Read an Excerpt

PrefaceHow This Book Is Organized

Read Me First! is organized as described in the following paragraphs.

Chapter 1, "Mechanics of Writing," reviews basic punctuation rules and guidelines, plus other general writing rules and conventions. This chapter also notes exceptions to these rules, guidelines, and conventions.

Chapter 2, "Constructing Text," provides guidelines for tables, cross-references, headings, lists, and other text elements.

Chapter 3, "Writing Style," provides guidelines for writing in a style that facilitates effective communication.

Chapter 4, "Online Writing Style," provides guidelines for writing documentation that is intended primarily for online presentation. Some of these guidelines also apply to online help and web pages.

Chapter 5, "Constructing Links," provides guidelines for using links effectively in online documents.

Chapter 6, "Writing Tasks, Procedures, and Steps," provides guidelines for writing tasks, procedures, and steps in a procedure.

Chapter 7, "Writing for an International Audience," provides guidelines for writing material that is easily understood by readers whose first language is not English and that can be easily translated into other languages.

Chapter 8, "Legal Guidelines," provides guidelines for the proper use of copyrights, trademarks, and proprietary information.

Chapter 9, "Types of Technical Documents," describes the various parts that make up a manual and lists the order in which they appear. This chapter also describes typical types of computer documentation.

Chapter 10, "Working With an Editor," explains how writers and editors work together to produce high-quality documents.

Chapter 11,"Working With Illustrations," describes illustration formats, styles, and types. This chapter also provides guidelines for writing callouts, arranging callouts, using leader lines, and writing captions.

Chapter 12, "Writing About Graphical User Interfaces," explains how to document graphical user interfaces (GUIs). This chapter also provides specific guidelines for writing about web pages and referencing URLs.

Chapter 13, "Glossary Guidelines," explains how to create a glossary for a technical manual.

Chapter 14, "Indexing," explains how to prepare an index for a technical manual. This chapter covers issues such as selecting topics to index, style rules for creating an index, and editing the index.

Appendix A, "Developing a Publications Department," provides information about issues related to a documentation department, including topics such as scheduling, roles and responsibilities, technical review, and printing and production.

Appendix B, "Checklists and Forms," contains sample checklists and forms that you can use at various stages of documentation development, including art tracking, print authorization, and a technical review cover letter.

Appendix C, "Correct Usage of Terms," provides alternatives for terms that you should not use in technical documentation, and terms that you should avoid. This appendix also provides some guidance related to commonly confused words and terms.

Appendix D, "Recommended Reading," presents a list of books, divided by subject headings, that you might want to consult for additional information.Changes for This Revision

Since the last revision of Read Me First!, the globalization of technical products has increased, and online delivery has become a fast-growing means of delivery for technical documentation. Read Me First! has been extensively revised in response to these changes. The highlights of this revision are as follows:


  • A more logical organization of chapters
  • Addition of a chapter on online writing style
  • Addition of a chapter on constructing links
  • Addition of a chapter on writing tasks, procedures, and steps
  • Extensive revisions to the chapters that discuss the following topics:
    - Writing for an international audience
    - Legal guidelines
    - Working with illustrations
    - Writing about graphical user interfaces
  • Incorporation of guidelines for easing the translation of documents
Read More Show Less

Table of Contents

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.

Read More Show Less

Preface

Preface

How This Book Is Organized

Read Me First! is organized as described in the following paragraphs.

Chapter 1, "Mechanics of Writing," reviews basic punctuation rules and guidelines, plus other general writing rules and conventions. This chapter also notes exceptions to these rules, guidelines, and conventions.

Chapter 2, "Constructing Text," provides guidelines for tables, cross-references, headings, lists, and other text elements.

Chapter 3, "Writing Style," provides guidelines for writing in a style that facilitates effective communication.

Chapter 4, "Online Writing Style," provides guidelines for writing documentation that is intended primarily for online presentation. Some of these guidelines also apply to online help and web pages.

Chapter 5, "Constructing Links," provides guidelines for using links effectively in online documents.

Chapter 6, "Writing Tasks, Procedures, and Steps," provides guidelines for writing tasks, procedures, and steps in a procedure.

Chapter 7, "Writing for an International Audience," provides guidelines for writing material that is easily understood by readers whose first language is not English and that can be easily translated into other languages.

Chapter 8, "Legal Guidelines," provides guidelines for the proper use of copyrights, trademarks, and proprietary information.

Chapter 9, "Types of Technical Documents," describes the various parts that make up a manual and lists the order in which they appear. This chapter also describes typical types of computer documentation.

Chapter 10, "Working With an Editor," explains how writers and editors work together to produce high-quality documents.

Chapter 11, "Working With Illustrations," describes illustration formats, styles, and types. This chapter also provides guidelines for writing callouts, arranging callouts, using leader lines, and writing captions.

Chapter 12, "Writing About Graphical User Interfaces," explains how to document graphical user interfaces (GUIs). This chapter also provides specific guidelines for writing about web pages and referencing URLs.

Chapter 13, "Glossary Guidelines," explains how to create a glossary for a technical manual.

Chapter 14, "Indexing," explains how to prepare an index for a technical manual. This chapter covers issues such as selecting topics to index, style rules for creating an index, and editing the index.

Appendix A, "Developing a Publications Department," provides information about issues related to a documentation department, including topics such as scheduling, roles and responsibilities, technical review, and printing and production.

Appendix B, "Checklists and Forms," contains sample checklists and forms that you can use at various stages of documentation development, including art tracking, print authorization, and a technical review cover letter.

Appendix C, "Correct Usage of Terms," provides alternatives for terms that you should not use in technical documentation, and terms that you should avoid. This appendix also provides some guidance related to commonly confused words and terms.

Appendix D, "Recommended Reading," presents a list of books, divided by subject headings, that you might want to consult for additional information.

Changes for This Revision

Since the last revision of Read Me First!, the globalization of technical products has increased, and online delivery has become a fast-growing means of delivery for technical documentation. Read Me First! has been extensively revised in response to these changes. The highlights of this revision are as follows:

  • A more logical organization of chapters
  • Addition of a chapter on online writing style
  • Addition of a chapter on constructing links
  • Addition of a chapter on writing tasks, procedures, and steps
  • Extensive revisions to the chapters that discuss the following topics:
  • - Writing for an international audience
    - Legal guidelines
    - Working with illustrations
    - Writing about graphical user interfaces
  • Incorporation of guidelines for easing the translation of documents
Read More Show Less

Customer Reviews

Be the first to write a review
( 0 )
Rating Distribution

5 Star

(0)

4 Star

(0)

3 Star

(0)

2 Star

(0)

1 Star

(0)

Your Rating:

Your Name: Create a Pen Name or

Barnes & Noble.com Review Rules

Our reader reviews allow you to share your comments on titles you liked, or didn't, with others. By submitting an online review, you are representing to Barnes & Noble.com that all information contained in your review is original and accurate in all respects, and that the submission of such content by you and the posting of such content by Barnes & Noble.com does not and will not violate the rights of any third party. Please follow the rules below to help ensure that your review can be posted.

Reviews by Our Customers Under the Age of 13

We highly value and respect everyone's opinion concerning the titles we offer. However, we cannot allow persons under the age of 13 to have accounts at BN.com or to post customer reviews. Please see our Terms of Use for more details.

What to exclude from your review:

Please do not write about reviews, commentary, or information posted on the product page. If you see any errors in the information on the product page, please send us an email.

Reviews should not contain any of the following:

  • - HTML tags, profanity, obscenities, vulgarities, or comments that defame anyone
  • - Time-sensitive information such as tour dates, signings, lectures, etc.
  • - Single-word reviews. Other people will read your review to discover why you liked or didn't like the title. Be descriptive.
  • - Comments focusing on the author or that may ruin the ending for others
  • - Phone numbers, addresses, URLs
  • - Pricing and availability information or alternative ordering information
  • - Advertisements or commercial solicitation

Reminder:

  • - By submitting a review, you grant to Barnes & Noble.com and its sublicensees the royalty-free, perpetual, irrevocable right and license to use the review in accordance with the Barnes & Noble.com Terms of Use.
  • - Barnes & Noble.com reserves the right not to post any review -- particularly those that do not follow the terms and conditions of these Rules. Barnes & Noble.com also reserves the right to remove any review at any time without notice.
  • - See Terms of Use for other conditions and disclaimers.
Search for Products You'd Like to Recommend

Recommend other products that relate to your review. Just search for them below and share!

Create a Pen Name

Your Pen Name is your unique identity on BN.com. It will appear on the reviews you write and other website activities. Your Pen Name cannot be edited, changed or deleted once submitted.

 
Your Pen Name can be any combination of alphanumeric characters (plus - and _), and must be at least two characters long.

Continue Anonymously
Sort by: Showing 1 Customer Reviews
  • Posted June 12, 2013

    WOW... I love MyDeals247 model - they create competition among t

    WOW... I love MyDeals247 model - they create competition among the sellers real-time.

    Was this review helpful? Yes  No   Report this review
Sort by: Showing 1 Customer Reviews

If you find inappropriate content, please report it to Barnes & Noble
Why is this product inappropriate?
Comments (optional)