Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Document Properties Marker
hidetrue
extract-short-desctrue


Short DescriptionProvides doctypes to document a system or software architecture based on the arc42 Template. 
Doctypetopichide
Nameprojectdoc Add-on for arc42hide
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
hide
Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
hide
Expected Durationhide
Categories
Name List
doctypecategory
names/ projectdoc / Doctype Add-on
propertyCategories
hide
Tags
Tag List
namesDoctype Add-on
propertyTags
hide
Iteration

Iteration
valuefinished

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesDoctype Set
propertyType
hide
Sort Key000120hide
Logo
hide
Setarc42hide
Blueprint Key Prefixde.smartics.atlassian.confluence.smartics-projectdoc-confluence-arc42:projectdoc-arc42-blueprint-doctype-hide
Status
Status
colourGreen
titleAvailable
hide
Example ProjectHTML Sanity Checker Architecture Documentation 




Section
idDescription
titleOverview

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-urihttp://arc42.org/
render-anonymousfalse
sourcearc42.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
idshort-copyright-notice


Panel
borderColordarkblue
borderWidth3

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
titleSo what is in for me using this add-on?

 Simply put:

Create by wizard, don't copy-paste



projectdoc-transclusion-macro
documentDoctypes
idslocalization


projectdoc-section
titleSpace 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
titleGet 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
titleAdd the arc42 Template

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


Section
titlePage 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
titleBlackbox Document in Editor

 

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



Column


Panel
titleBlackbox 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
borderColordarkgreen
titleColorwhite
titleBGColordarkgreen
titlearc42 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
titlePrerequisites

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
width50%


Panel
titleColorwhite
titleBGColororange
title1. Install projectdoc Toolbox

Install add-on now

Atlassian Marketplace



Column
width50%


Panel
titleColorwhite
titleBGColororange
title2. Install Core Doctypes!

Install the Core doctype add-on now and for free

Atlassian Marketplace




Section


Column
width50%


Panel
titleColorwhite
titleBGColororange
title3. Install Doctypes for Software Development!

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

Atlassian Marketplace



Column
width50%


Panel
titleColorwhite
titleBGColororange
title4. Install Add-on for arc42

Install the arc42 Template for projectdoc now and for free

Atlassian Marketplace




Transclusion
documentDoctype Add-on Sources
idsarc42



Section
titleAbstract


Section
titleList of Doctypes for Software Development


Section


Column
width50%

The following doctypes help to document your software projects.

Display Table
doctypedoctype
selectName, Short Description
sort-bySort Key, Name
whereAdd-on= "arc42 Add-on"
render-counter-columntrue

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


Column


Panel
borderColordarkgreen
titleColorwhite
titleBGColordarkgreen
titleLightweight 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
titleRelated Macros

The following macros are provided by this add-on.

Display Table
doctypemacro
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
whereAdd-on = "arc42 Add-on"


Section
required-permissionswrite-access
titleNotes


Section
titleReferences


Section
titleResources

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-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue


TitleShort DescriptionDoctype
How to document a Software Development Project  
HTML Sanity Checker Architecture Documentation  
Tour for Document Authors  
Doctypes  
Macros  
#arc42Track the arc42 hashtag on Twitter!-
arc42 – Architekturen effektiv kommunizierenBlog article by Gernot Starke about the latest version of the arc42 Template (in German).Blog Article




Content Marker
hidetrue


Transclusion
documentarc42 10th Anniversary Promotion
idsContent



Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categorydoctype-add-on
Typearc42