An example of an software architecture documentation based on the arc42 Template on Confluence 5 with projectdoc and the projectdoc Add-on for arc42.
This example is based on the HTML Sanity Checker Architecture Documentation created by the arc42 team using AsciiDoc (available on GitHub). This example shows the application of the arc42 Template to create the software architecture documentation for a standalone tool (batch- and command-line) that detects missing images, dead links, duplicate bookmarks.How to document a Software Development Project is an introduction to start creating documentation with the arc42 Template on Confluence with blueprints.
projectdoc Add-on for arc42
The projectdoc Toolbox makes it easier for teams to create and maintain a modular documentation they can collaboratively work with. The arc42 Template allows to bring this modular information into a well-know structure. This enhances the usability of the architecture documentation since many software developers and architects know arc42.
Create by Wizard
projectdoc provides templates that help you document your software project that are not or only loosely related to architecture documentation.
If you have created the arc42 Space, the arc42 Template is already available in the space.
How to document a Software Development Project is an introduction to start creating documentation with the arc42 Template on Confluence with blueprints.
A template helps authors to provide the content in a commonly defined structure. Documentation is created incrementally, therefore some of the sections of a template are added at a later time. To not bother the reader with sections that may or may not be added in the future, projectdoc allows the author to have the empty sections in the template for future use, but will only render them if they actually have content.
Here is an example:
The information that is relevant for the software architecture is added in separate wiki pages as documents. Therefore there are document types for stakeholders, roles, architecture decisions, interfaces, and many others.
The information is then transcluded into the arc42 template.
Get started with arc42 on Confluence with projectdoc in 4 easy steps!
Both add-ons are available on the Atlassian Marketplace for free. Note that Atlassian Confluence and the projectdoc Toolbox have commercial licenses.