projectdoc Add-on for arc42

Document Properties Marker

hide	true
extract-short-desc	true

Short Description Provides doctypes to document a system or software architecture based on the arc42 Template.

Doctype topic hide

Name projectdoc Add-on for arc42 hide

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

hide

Level of Experience

Name List

doctype	experience-level
render-no-hits-as-blank	true
property	Level of Experience

hide

Expected Duration hide

Tags

Tag List

names	Doctype Add-on
property	Tags

hide

Iteration


value	filled

hide

Type

Name List

doctype	topic-type
render-no-hits-as-blank	true
names	Doctype Set
property	Type

hide

Sort Key 000120 hide

Logo hide

Set arc42 hide

Blueprint Key Prefix de.smartics.atlassian.confluence.smartics-projectdoc-confluence-arc42:projectdoc-arc42-blueprint-doctype- hide

Status

colour	Green
title	Available

hide

Example Project HTML Sanity Checker Architecture Documentation

Section

id	Description
title	Overview

This free add-on for projectdoc provides blueprints to bring the arc42 Template to the Confluence team collaboration platform for easy use.

Section

Column

Quote External

source-uri	http://arc42.org/
render-anonymous	false
source	arc42.org

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 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.

Column

Content Marker

id	short-copyright-notice

Panel

borderColor	darkblue
borderWidth	3

For more information on the arc42 Template, please visit its homepage at arc42.org!

arc42 is owned by
Dr. Peter Hruschka & Dr. Gernot Starke

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.

Panel

borderColor	#192E59
titleColor	#192E59
titleBGColor	#89A3C3
title	So what is in for me using this add-on?

Simply put:

Create by wizard, don't copy-paste

Section

title	Space Wizard

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.

Tip Box

title	Get Started!

We strongly recommend to read How to document a Software Development Project to get started using the PDAC1 to work on your arc42 Template.

Section

title	Add the arc42 Template

If you want to add the arc42 Template to an existing space, use the page blueprint 'arc42 SWAD'.

Image RemovedImage Added

Section

title	Page Wizard

Instead of copying pages around, just select a blueprint to create a new page based on a template like Blackbox, Architecture Decision, or Interface!

Section

Column

Panel

title	Blackbox Document in Editor

The new page contains in its sections information about how to work with the template.

Column

Panel

title	Blackbox Document in View

The Blackbox in View Mode

Due to the Section Macro, the reader's view is not cluttered with sections without any information.

Panel

borderColor	darkgreen
titleColor	white
titleBGColor	darkgreen
title	arc42 Template on projectdoc

Get a quick and more detailed impression on how the arc42 Template on Confluence 5 looks like!

Also check out the live example HTML Sanity Checker Architecture Documentation (based on the original example on GitHub)!

projectdoc provides additional templates that help you document your software project that are not or only loosely related to architecture documentation.

Section

title	Prerequisites

The projectdoc Add-on for arc42 uses templates from the Core Doctypes for projectdoc (like Role or Stakeholder) and from the Software Development Doctypes (like Architecture Decision or View).

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:

Section

Column

width	50%

Panel

titleColor	white
titleBGColor	orange
title	1. Install projectdoc Toolbox

Install add-on now

Column

width	50%

Panel

titleColor	white
titleBGColor	orange
title	2. Install Core Doctypes!

Install the Core doctype add-on now and for free

Section

Column

width	50%

Panel

titleColor	white
titleBGColor	orange
title	3. Install Doctypes for Software Development!

Install the doctypes add-on for software development now and for free

Column

width	50%

Panel

titleColor	white
titleBGColor	orange
title	4. Install Add-on for arc42

Install the arc42 Template for projectdoc now and for free

Transclusion

document	Doctype Add-on Sources
ids	arc42

Section

title	Abstract

Section

title	List of Doctypes for Software Development

Section

Column

width	50%

The following doctypes help to document your software projects.

Display Table

doctype	doctype
select	Name, Short Description
sort-by	Sort Key, Name
where	Add-on= "arc42 Add-on"
render-counter-column	true

More useful software development templates are part of the Software Development Doctypes.

Column

Panel

borderColor	darkgreen
titleColor	white
titleBGColor	darkgreen
title	Lightweight Markup Language for arc42?

arc42 supports different formats to create your system or software architecture. While a wiki helps team members from different fields (especially fields where using a SCM server is not daily business), developers by their own often strive for a format where they do not have to install extra software and are able to check-in the documentation along with their code.

Ralf Müller manages a couple of projects on GitHub to use the arc42 Template with asciidoc.

Section

title	Related Macros

The following macros are provided by this add-on.

Display Table

doctype	macro
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
where	Add-on = "arc42 Add-on"

Section

required-permissions	write-access
title	Notes

Section

title	References

Section

title	Resources

These resources provide additional information on creating system and software documentation in your wiki using the arc42 Template and the projectdoc Toolbox.

Tour

render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description	Doctype
How to document a Software Development Project
HTML Sanity Checker Architecture Documentation
Tour for Document Authors
Doctypes
Macros
#arc42	Track the arc42 hashtag on Twitter!	-

Content Marker

hide	true

Transclusion

document	arc42 10th Anniversary Promotion
ids	Content

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 2

New Version 3

Key

About

Keep up-to-date!

Powered by