arc42 - the template for software architecture documentation and communication
Initially created by Dr. Gernot Starke and Dr. Peter Hruschka (way back in 2005…), free and open source.
If you want to use an arc42 template, you don’t need to use this project - just use one of the templates you find on http://arc42.de/ , http://arc42.org/ or https://arc42.github.io/
This repository currently contains the "Golden Master" of the arc42 template in english and german and it contains gradle projects to convert the golden master into other formats. In order to make it really easy to use this gradle project, the repository includes the gradle-wrapper - a script which will automatically install gradle for you if it is not already installed.
In order to create the other formats from the "Golden Master", follow these steps:
-
gradlew createTemplatesFromGoldenMaster
This will extract the "plain" and "with-help"-version from the golden master. You’ll find the templates in different languages in build\src_gen in AsciiDoc format.
Btw: gradle allows you to "shorten" the command - as long as gradle is still able to guess the command, anything goes :-). gradlew createT is as valid as gradlew cTFGM.
After you have executed the task to create the templates, a new task will become available in gradle:
-
gradlew arc42
|
Note
|
for this step to work, you need pandoc installed with version 1.12.4.2 or higher. |
This will create all other formats. They will be located directly in the build directory. This is still work in progress. Some of the build steps need extra tools like pandoc installed, so it is likely that you encounter errors.
We collected the arc42 requirements in its own document.
Please be patient - downloads will be available from here once we establish the travis-based continous build system.
| Version/Format | MS-Word (c), docx | Confluence | html | asciidoc | textile | |
|---|---|---|---|---|---|---|
skeleton structure |
skel-confluence |
skel-pdf |
||||
… plus explanation |
help-confluence |
help-pdf |
| Version/Format | MS-Word (c), docx | Confluence | html | asciidoc | textile | |
|---|---|---|---|---|---|---|
skeleton structure |
skel-confluence |
skel-pdf |
||||
… plus explanation |
help-confluence |
help-pdf |