Building Modular DocumentationBy
- Kurt Ament
Technical writers and editors that want flexible framework for developing successful single-source documentation. Technical publications managers who want to standardize corporate publications to improve quality and save time and money. Teachers and students who want to learn successful single sourcing techniques that are actually used in corporate environments.
Paperback, 245 Pages
Published: October 2002
Imprint: William Andrew
"The book is an easy read and is chock full of tips and guidelines." -Ann Rockley
- About Single Sourcing What Is Single Sourcing? Reasons for Single Sourcing How Single Sourcing Works Types of Single Sourcing Successful Single SourcingBuilding 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 7. Cross-Referencing Documents Step 8. Converting Documents Step 9. Testing Documents Step 10. Developing GuidelinesStructuring 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 TopicsTroubleshooting Scenarios Configuring Language Abbreviations Capitalization Parallel Construction Person Punctuation Sentence Construction Tense Voice Leveraging Technology Conditional Text Conventions Development Tools Filenames Localization Search Engines Variables Glossary Index