Provides doctypes to document a system or software architecture based on the arc42 Template.
arc42 supports software- and system architects. It is based upon practical experience of many architecture projects of different sizes and domains. It includes feedback of its many users.arc42.org
arc42 contains a template for development, documentation and communication of software architectures.
arc42 fits arbitrary technologies and tools.
arc42 therefore ensures better software- and system architectures.
projectdoc Toolbox makes it easier for teams to create and maintain a modular documentation they can collaboratively work with. The arc42 Template bring this modular information into a well-know structure. This enhances the usability of the architecture documentation since many software developers and architects know how to document their software and systems architecture with arc42.
Instead of copying spaces around, create one with the space wizard.
This will create a space with the arc42 Template.
The main page of has references to documents for each section of the arc42 template.
Add the arc42 Template
If you want to add the arc42 Template to an existing space, use the page blueprint 'arc42 SWAD'.
Both Add-ons are available on the Atlassian Marketplace for free. Note that the projectdoc Toolbox has a commercial license.
Please install the following add-ons in your Confluence server:
List of Doctypes for Software Development
The following doctypes help to document your software projects.
The blueprint of the arc42 Template creates a tree of pages in the Confluence space.
Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
Interfaces document how elements of the system communicate with elements of this and other systems.
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
More useful software development templates are part of the Software Development Doctypes.
The following macros are provided by this add-on.
- Interface Type Macro
- Selects the type of an interface.
These resources provide additional information on creating system and software documentation in your wiki using the arc42 Template and the projectdoc Toolbox.
There is no one-size-fits-all for documenting software projects. What we do is giving you an introduction on how to get started with the projectdoc Toolbox and the Software Development Add-on to define your documentation requirements with Confluence.
An example of an software architecture documentation based on the arc42 Template on Confluence 5 with projectdoc and the projectdoc Add-on for arc42.
Tour through the documentation for users who want to learn to create documents based on projectdoc doctypes.
Doctypes define properties and sections for documents. They are essentially Confluence Blueprints that help to create pages in your wiki based on templates.
List of macros provided by the projectdoc Toolbox.
|#arc42||Track the arc42 hashtag on Twitter!||-|