I need more support to organize team work in our Confluence space(s)! How can projectdoc help me?
- Parent
- Tags
Question
I need more support to organize team work in our Confluence space(s)! How can projectdoc help me?
Answer
Modular Documentation
Team work is more efficient, if you increase the number of documentation modules since they can be worked on simultaneously by team members. Modular is harder than writing a single large document, since you have to keep track of the fragments and create your documents using transclusion. And too many transclusions will slow down your rendering response.
Test your transcluded documents for performance on your systems.
projectdoc provides macros for transclusion to help you with single sourcing (see Accuracy in the Practical Advice section for more information about modular documentation and single sourcing).
- Document Properties Supplier Attachment Macro
- A table supplying additional document properties from an attached file.
- Document Properties Supplier From Documents Macro
- Import properties from another projectdoc document.
- Document Properties Supplier Macro
- A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property.
- Index Card Macro
- Renders transcluded content fetched from documents of a result set.
- Random Transclusion Macro
- Transcludes random content from a document marked with the content marker macro.
- Tour-by-Property Macro
- Renders a predefined list of documents in a table . Documents are selected by a document property. Allows to select document properties for columns. Also non-list representations are provided.
- Transclude Documents Macro
- Renders transcluded content fetched from documents of a result set.
- Transclusion Macro
- Transcludes content from a document marked with the content marker macro.
- Transclusion Reference Macro
- Transcludes content via a reference from a document marked with the content marker macro.
- Transclusion to Text Macro
- Transcludes content from a document marked with the content marker macro and renders it as plain text.
The Section and Content Marker Macro mark a text fragment for transclusion. The transclusion macros actually grab the content and make it visible on other documents.
Team Communication
projectdoc provides macros to help authors to communicate the state of documents and sections.
- Define the current state using the Iteration Macro (this is included as the Iteration Property in most doctypes)
- Use box macros like Pending Box Macro or Feedback Box Macro to communicate with your team mates
- Use the Documentation Dashboard to track the box information
projectdoc also provides templates to help you communicate with your team:
- Doctypes for Agile Planning
- Provides doctypes to collborate with your team. Run iterations and record discoveries that may be of interest at the end of the iteration or for even later reference. Quick notes are more easily added as records to the team's space than to the official documentation tree. Defer the talk to the documentation architect to the end of the iteration (if the discovery is still of interest).
- projectdoc Developer Diaries
- Provides doctypes to organize the developer's work by the employment of a diary. Take you personal planning and professional records to the next level!
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?
- Accuracy
- We have problems keeping the information in our Confluence space(s) up-to-date! How can projectdoc help me?