Preface

Read Me First! A Style Guide for the Computer Industry provides everything you always wanted to know about documenting computer products, from creating screencasts to documenting web sites, from writing for an international audience to developing a documentation department.

How This Book Is Organized

This book 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.

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

Get Read Me First! A Style Guide for the Computer Industry, Third Edition now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.