|
B O O K S
Single Sourcing: Building Modular Documentation
by Kurt Ament
Overview | Contents | Reviews | Order
This guide is organized into five chapters. It contains a glossary and index.
- Foreword
-
- Preface
-
- Chapter 1. About single sourcing
- What is single sourcing?
- Reasons for single sourcing
- How single sourcing works
- Types of single sourcing
- Successful single sourcing
-
- Chapter 2. Building documents
- Step 1. Identifying modules
- Step 2. Labeling modules
- Step 3. Organizing modules
- Step 4. Building modules
- Step 5. Editing modules
- Step 6. Organizing documents
- Step 8. Converting documents
- Step 9. Testing documents
- Step 10. Developing guidelines
-
- Chapter 3. Structuring content
- Captions
- Cross-references
- Definition lists
- Examples
- Figures
- Front matter
- Glossaries
- Headings
- Indexes
- Itemized lists
- Notes
- Organization
- Procedures
- Processes
- Section contents
- Tables
- Tables of contents
- Topics
- Troubleshooting scenarios
-
- Chapter 4. Configuring language
- Abbreviations
- Capitalization
- Parallel construction
- Person
- Punctuation
- Sentence construction
- Tense
- Voice
-
- Chapter 5. Leveraging technology
- Conditional text
- Conventions
- Development tools
- Filenames
- Localization
- Search engines
- Variables
-
- Glossary
-
- Index
|
