Read Me First! A Style Guide for the Computer Industry

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

Descripción completa

Detalles Bibliográficos
Autor principal: Sun Technical Publications Staff (corporate author)
Autores Corporativos: Sun Technical Publications Staff Corporate Author (corporate author), Safari Tech Books Online (-), Sun Technical Publications
Otros Autores: Publications, Sun, author (author)
Formato: Libro electrónico
Idioma:Inglés
Publicado: [Place of publication not identified] Sun Microsystems Press Imprint 2003
Edición:2nd ed
Materias:
Ver en Biblioteca Universitat Ramon Llull:https://discovery.url.edu/permalink/34CSUC_URL/1im36ta/alma991009627421606719
Descripción
Sumario: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
Notas:Bibliographic Level Mode of Issuance: Monograph
Descripción Física:1 online resource (xxii, 356 p. ) ill
Available also in a print edition
Bibliografía:Includes bibliographical references (p. 319-334) and index.