- ホーム
- > 洋書
- > 英文書
- > Computer / Languages
Full Description
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.
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.
