vonloh / arc42-template

arc42 - the template for software architecture documentation and communication

Template ("Golden Master")

arc42 - the template for effective, practical and pragmatic software architecture documentation and communication.

Initially created by Dr. Gernot Starke and Dr. Peter Hruschka (way back in 2005…​), free and open source.

This repository contains all downloadable versions plus the (AsciiDoc) source of the arc42 template.

It is used to:

• generate (by the arc42-generator project) the official download formats (i.e. docx, markdown, docbook and others).

• maintain structure, content and help for the template

• keep non-asciidoc, non-generable formats (like Sparx® Enterprise-Architect® EAP).

In case you find issues within the template or its explanations, this is the repo to fix and issue pull requests :-)

Downloads

Please refer to the official download page for all downloads.

Languages

The EN and DE versions are actively maintained by the founders (G.Starke & P.Hruschka). Translations to additional languages (IT, ES, RU) have been provided by volunteers, but won’t be automatically updated.

Build the HTML version

In case you want to build the HTML version of the template, just checkout this repo and call

$> gradle asciidoctor

on the command line. Within the build.gradle script, you might replace the default language (EN) with your choice.

Questions on using arc42?

• see the extensive documentation website

• see the overview

Suggestions welcome

Open an issue here!