Skip to content

Latest commit

 

History

History
100 lines (66 loc) · 4.71 KB

arc42.md

File metadata and controls

100 lines (66 loc) · 4.71 KB
layout title subtitle
default
arc42
software architecture

what is arc42?

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.

Together with arc42 we propose a lightweight set of activities (process) for effective construction and development of software architectures.

You can use arc42 for free, even for commercial applications. We are happy when you quote us.


examples

This is a list of all known public available examples of arc42 documentation. Feel free to contact us if you have a link to another example.

HTML Sanity Checker (Englisch)
Verbose example for the documentation of a Gradle plugin, created by Dr. Gernot Starke.

DocChess (German)
Verbose example for a chess engine, created by Stefan Zörner. There is also a book available which describes the creation of this example.

Gradle (German)
A series of blog posts which describe certain aspects of Gradle and put them into context of arc42. Created by Stefan Zörner.

Financial Data Migration (mostly English)


downloads

Currently there are two sources for downloads...

Confluence - on our confluence landing page you'll find docx and confluence templates in German, English and Spanish:

Confluence

GitHub - on GitHub you'll find the new AsciiDoc version of the template together with a project which converts the AsciiDoc template into several other formats. These templates are currently available in English and German:

Templates

Here are all templates derived from the AsciiDoc templates in a single overview:

{% assign formats = "asciidoc|docbook|docx|epub|html|markdown|markdownMP|textile" | split: "|" %}
{% assign types = "plain|withhelp" | split: "|" %}

Format Language Plain With Help
{% for format in formats %} {{ format }} EN {% for type in types %} .zip
DE {% for type in types %} .zip {% endfor %}
{% endfor %} Confluence EN
DE 5.x oder 6.x, 4.3, 4.2

If you consider to use confluence, the asciidoc2confluence script might be helpful.

You can also view the HTML version with help online: EN / DE

other related sites and literature

sites

arc42.de (German) and arc42.org (English) are the main sites where you can find more background details about the template, trainings and literature.

books

Gernot Starke:
Effektive Softwarearchitekturen - Ein praktischer Leitfaden.
Carl Hanser Verlag, 6, Auflage 2014.
ISBN 978-3446436145

Gernot Starke und Peter Hruschka:
Softwarearchitektur kompakt.
Springer Akademischer Verlag, 2. Auflage 2011.
ISBN 978-3827428349

Stefan Zörner:
Softwarearchitekturen dokumentieren und kommunizieren.
Carl Hanser Verlag, 2012.
ISBN 978-3446443488