How to create a space to start documenting your software architecture or software system using the projectdoc Toolbox for Confluence and additional free add-ons.
Create a Space
Create a space with the projectdoc Add-on for arc42 (recommended) or the Software Development Add-on.
Provide a name and a short description for your space.
Click 'Create' to create your new space.
The screenshots show links to homepages for document types. The orange panels provide access to the core document types while the blue panels refer to documents concerned with software development. This is something software developers know as a standard directory layout (e.g. the Standard Directory Layout defined by Maven). The location of a document is defined by its type.
The arc42 Template is a Volume according to projectdoc. It is referenced in the Volumes Panel (as soon as you create it with the name "Software Architecture Documentation"). Lets create an instance for the arc42 Template!
Create your SWAD
In case you created the arc42 Space, the arc42 Template is already created. Therefore skip this section.
The software architecture documentation (SWAD) is the source of all answers according to your software or system architecture.
Also use the page blueprint if you want to add the arc42 Template to an existing space.
Launch the page wizard and select the arc42 SWAD template. This is the implementation of the arc42 Template by projectdoc.
Then provide the required information or select the defaults (which is recommended).
If you choose the name Software Architecture Documentation, the existence of a page with this name in the space will activate the link with the same name in your Volume Panel.
The SWAD provides the structure of the arc42 Template. That is 12 subpages, one for each chapter defined by the arc42 Template.
If you prefer, you may view the document on a single page by clicking in the "SWAD (Single Page) link that is part of the document properties. Note that transclusions are by nature slower than the linked representation above. Usually you will work with the multipage version and use the single page version in case you want all on one page.
The chapters are transcluded from the referenced subpages. The blue boxes around the chapters help authors to jump to the source of the information easily. The boxes are not rendered for users that have only read privileges.
Please note that the glossary chapter will only be rendered, if you have at least on glossary item defined.
