Read me first! : a style guide for the computer industry / Sun Technical Publications.

A guide to creating technical documentation, this covers everything from grammar to clarity, illustrations to workflow. This second edition reflects changes in the production and delivery of technical documentation.

Saved in:
Bibliographic Details
Online Access: Full Text (via Internet Archive)
Corporate Author: Sun Technical Publications
Format: eBook
Language:English
Published: Upper Saddle River, N.J. : Pearson Education [distributor], Prentice Hall ; 2010.
Edition:3rd ed.
Subjects:
Table of Contents:
  • Mechanics of writing
  • Constructing text
  • Writing style
  • Structuring information
  • Online writing style
  • Constructing links
  • Writing tasks, procedures, and steps
  • Writing for an international audience
  • Legal guidelines
  • Types of technical documents
  • Writing with an editor
  • Working with illustrations
  • Writing alternative text for nontext elements
  • Documenting graphical user interfaces
  • Creating screencasts
  • Using wikis for documentation
  • Glossary guidelines
  • Indexing. mglib.