Hi all,
This is the alpha review of the OpenSolaris Style Guide TOC. Please
review the outline below with focus on errors (topics we should not
include) and omissions (additional topics you want to include).
Comments, questions, and feedback on the table of contents should be
provided by next Friday, Nov. 4th. If this is not enough time, let me
know.
Please email comments to the alias so that we can efficiently capture
and address any conflicting or common additions and suggestions.
Proposal: OpenSolaris Style Guide
Table of Contents
__________________________________
Preface
About This Guide
How This Book Is Organized
Who Should Read This Guide
Associated Documentation
Related Documentation
Reference Sources
1. Constructing Text
Headings
Lists
Tables
Code Examples
Man Page References
Error Messages
Cross-References
Notes, Cautions, and Tips
Illustrations
2. Technical Documentation Concepts
Stylistic Principles
Online Writing Style
Write for the Reader
Avoid Style That Could Offend the Reader
Common Writing Problems to Avoid
Structure
Types of Software Manuals
Other Product Documents
3. Writing for an International Audience
Guidelines for Writing for Translation
4. Checking and Reviewing Your Document
Reviews
Checks You Can Do Yourself
5. Indexing Your Documentation
Creating an Index
Refining and Checking an Index
6. Glossary Guidelines
Glossary Content
Writing Good Glossary Entries
7. Legal Guidelines
Legal Requirements Checklist
OpenSolaris License Agreement CDDL
Copyrights and Trademark Attributions
8. Writing Alternative Text for Nontext Elements
General Guidelines for Writing Alternative Text
Writing About Nontext Elements
9. Writing for the Solbook DTD
General Guidelines for Writing to the Solbook DTD
A. General Word Usage
B. OSSG Contributors
Coming Soon:
Beta version of the TOC will include the following:
-implmentation of all alpha review feedback
-third level of outline detail
-updated list of contibutors
Thanks,
Michelle Olson
OpenSolaris Doc Community
