A book/CD-ROM reference for technical writers, editors, and documentation managers working on documenting hardware, software, and other computer products. Offers grammar and punctuation guidelines, typographic conventions, and advice of creating bibliographies and indexes, and covers how to document software running under a graphical user interface, creating international and online documentation, working with illustrators and printers, hiring writers, and organizing the review process. Includes checklists, forms, and tables of conventions. The CD-ROM contains the text of the book in searchable FrameViewer and HTML format. Annotation c. by Book News, Inc., Portland, Or.
45534-5
The must-have reference for every technical writer, editor, and documentation manager.
Circle-I stands for information, and Read Me First! provides all the information you need if you face the challenge of documenting hardware, software, or other computer products.
Written by award-winning documentation experts at Sun Technical Publications, Read Me First! is the most comprehensive guide to creating documentation that is clear, consistent, and easy to understand.
Read Me First! is a complete style reference. It compiles grammar and punctuation guidelines, typographic conventions, and pointers on creating a bibliography, including how to reference online source material. There's even practical guidance on indexing. It also covers how to document software running under a graphical user interface ― something that is ignored in traditional style guides.
If you're responsible for managing documentation, you'll find Read Me First! invaluable. It provides guidance on creating international and online documentation, working with illustrators, organizing the review process ― even satisfying the lawyers. It's all here: hiring writers, working with printers, developing realistic schedules, and much more.
You will immediately improve the way you write or manage documentation using the following:
- Checklists and forms for editing, tracking manuscripts, and verifying production status.
- Ready-to-use FrameMaker document templates.
- Tables of technical abbreviations, acronyms and units of measurement.
- Table of typographic conventions recommendations.
There is no better book on writing, editing, and managing documentation for computer products. If you're involved in documentation in any way, Read Me First! will be the most useful book you ever own.