We have problems keeping the information in our Confluence space(s) up-to-date! How can projectdoc help me?

Question

We have problems keeping the information in our Confluence space(s) up-to-date! How can projectdoc help me?

Answer

Modular documentation is easier to work on collaboratively and supports single sourcing. Single sourcing implies that an information is provided in one place and only one place. If the need arises to update a piece of information, e.g. due to a new release, the information is only updated in one place. This is much easier than updating an information in multiple places.

projectdoc supports modular documentation and single sourcing. First there is a doctype for documentation modules. Provide the information in a module and reference or transclude it from all other documents. While you may add information to any document and reuse this from there, the module doctype provides a query that automatically lists all documents that transclude the content (references to the document are already built into Confluence on the Page Information).

Here is an example of a module document:

The "Content" section can be transcluded by the Transclusion Macro. The section titled with "Transcluded By" lists all documents that import this text fragment.

 

Please keep in mind that transclusions from automatic lists (i.e. the Transclude Documents Macro) are not reported, since they are an adhoc search. Only macros that point explicitly to the document are taken into account for this list.

Further Practical Advices

Organization
I need more support to organize my documents in my Confluence space(s)! How can projectdoc help me?
Navigability
I need better navigation in my Confluence space(s)! How can projectdoc help me?
Findability
I need better way of finding information in my Confluence space(s)! How can projectdoc help me?
Collaboration
I need more support to organize team work in our Confluence space(s)! How can projectdoc help me?