Child pages
  • Ament2003

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
Doctyperesourcehide
NameSingle Sourcing - Building Modular Documentation 
Short DescriptionIntroduction to modular documentation. 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
empty-as-nonetrue
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Name List
doctypetag
propertyTags
 
Iteration
Iteration
valuefilled
 
Authors
Name List
doctypeperson
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesKurt Ament
propertyAuthors
 
Type
Name List
doctyperesource-type
render-no-hits-as-blanktrue
namesBook
propertyType
 
Version 
Publication Date2003 
License 
Location Amazon 
Rating
Rating
 
Sort Keyhide
Section
titleDescription
Quote

Single sourcing is a method for developing re-usable information.

Although project planning and document conversion are essential to any single sourcing project, it is modular writing that ultimately determines success. This guide explains in plain language and by example how to build modular documentation you can re-use in different formats for different audiences and purposes.

This guide begins with a conceptual overview of the single sourcing method. It then walks you through a 10-step process for converting linear documentation to modular documentation. Each step of the process is cross-referenced to detailed guidelines. These guidelines show you by example how to structure content, configure language, and leverage technology to maximize usability and re-usability.

To provide you with a realistic picture of the single sourcing process, the steps, guidelines, and examples in this guide are very specific. Each is based on successful single sourcing projects in the real world. To provide you with a flexible framework you can re-use for your own purposes, the guidelines are modular. Pick the guidelines you need. Then customize them to meet your specific needs.

Section
titleSummary

Modules are the basis for single sourcing.

Kurt Amend provides detailed information on how to get from modules to documents:

  1. Build modules
  2. Label modules
  3. Organize modules
  4. Edit modules
  5. Organize documents
  6. Cross-reference documents
  7. Convert documents
  8. Test documents
  9. Develop guidelines
Section
titleExcerpt
Display Table
doctypeexcerpt
render-no-hits-as-blanktrue
selectName, Short Description
sort-bySort Key, Name
restrict-to-immediate-childrentrue
Section
titleSubdocuments
Display Table
doctyperesource
render-no-hits-as-blanktrue
selectName, Short Description
sort-bySort Key, Name
restrict-to-immediate-childrentrue
Section
titleReferences

Section
titleNotes

Section
titleResources