ISBN-10:
0137058268
ISBN-13:
9780137058266
Pub. Date:
12/31/2009
Publisher:
Prentice Hall
Read Me First! A Style Guide for the Computer Industry / Edition 3

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

by Sun Technical Publications
Current price is , Original price is $49.99. You

Temporarily Out of Stock Online

Please check back later for updated availability.

Product Details

ISBN-13: 9780137058266
Publisher: Prentice Hall
Publication date: 12/31/2009
Edition description: Third Edition
Pages: 462
Sales rank: 1,077,558
Product dimensions: 7.40(w) x 8.90(h) x 1.20(d)

About the Author

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

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

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 forTranslation. 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.

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-qualitydocuments.

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 forwriting 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 aboutissues 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

Customer Reviews

Most Helpful Customer Reviews

See All Customer Reviews

Read Me First! A Style Guide for the Computer Industry 0 out of 5 based on 0 ratings. 0 reviews.