Reduce redundancy by having one source of truth for each information. This way the written information is more easily reusable in other documents and - which is even more important - it is referenceable. Single sourcing demands automation.
Creating documentation collaboratively requires teams to reuse information in order to create documents quickly and just-in-time. Changes to the documentation have to be applied quickly and with no redundancy. Otherwise it is easy to end up with out-dated information.
How can we ensure up-to-date documents without spending much resources?
Single sourcing is a method for systematically re-using information. With this method, you develop modular content in one source document or database, then assemble the content into different document formats for different audiences and purposes.
Although its primary goal is to save time and money, single sourcing improves the quality of your documentation.
Kurt Ament. Single Sourcing - Building Modular Documentation. 2003
Single sourcing requires some form of automation. Information often needs to be aggregated, filtered or simply transferred from its source to a alternate representation or location.
- Documents that are dedicated to a encapsulated piece of information are less often subject to change.
- Single sourcing reduces the cost of maintenance of the documents life-time.
- Writing modular documents for reuse is more difficult and needs training.
- Content reuse may result in constant refactorings where text snippets are extracted from an existing document into a module for transclusion.
For more information regarding this practice please refer to: