An overview over the use cases for which the projectdoc Toolbox provides support.
Working with templates turns your mind to focus on the content you want to communicate.
As an author it is still your responsibility to align your information with the structure of your document to help your readers getting to the point quickly. The structures of the templates aside, there is a basic structure that support you getting your stuff right.
- First motivate why the information is relevant for your audience. Define what the information is good for.
- Define the context the information is relevant in. Discuss the topic in-depth and provide the necessary background information.
- Provide examples on how to use or how it is already used. Maybe help your audience with a step-by-step guide.
- Envision on what will be next and possible extension points.
This four-step approach is explained in more detail by Stefan Zörner and Uwe Vigenschow. Their work is based on the quadrants typology of Carl Gustav Jung.
The following links provide more information on this topic, albeit in German:
- arc42-Starschnitt: Gradle. Schnipsel Nr. 9: Übergreifende Konzepte - article by Stefan Zörner; the topic is also discussed in his book Softwarearchitekturen dokumentieren und kommunizieren
- Softwareentwickler – die unbekannte Spezies - whitepaper by Uwe Vigenschow
- Die Quadranten-Typologie von C.G. Jung - video by Bernd Oestereich
The templates are guides to help you find areas to cover. They may or may not come naturally in the specified sequence of section. If the order of sections in the template does not support your point, change it! Your structure must support the information you transport.
Sections that do not help your topic are just left empty. If you later find they might contribute, add content and they will appear to your readers.
Highlights & Features
In Highlights and Features we list capabilities of the projectdoc Toolbox for Confluence.
