Page Comparison

Looking for the English version of the template?

Suchen Sie die englische Version des Templates?

• Confluence-space-export-7FG.xml.zip
• Confluence-space-export-7SG.xml.zip

Welcome to the arc42 Confluence Template space. Here you find all you need to get started with your software architecture documentation if you want to use Confluence as your content management system. 

But you still have several ways to use arc42 with Confluence:

1) Download and install one of the templates as Confluence space

There are two flavours for each language which we call 'flat' and 'structured'. The difference between them is just into how many Confluence pages the template has been split. The 'flat' version consists of one page per level 1 chapter (12 pages overall). The 'structured' versions consists of one page per level 2 chapter.

We've already prepared space exports for youWillkommen auf dem arc42 Confluence Template Space. Hier finden Sie alle nötigen Informationen um Ihre Software-Architektur mit arc42 in Confluence zu dokumentieren.

Allerdings haben Sie mehrere Optionen das arc42-Template mit Confluence zu nutzen:

1) Template runterladen und als Confluence Space installieren

Das Template gibt es für jede Sprache in zwei Geschmacksrichtungen, die wir als "flat" und "structured" bezeichnen. Der Unterschied liegt nur in der Anzahl der Confluence-Seiten auf die das Template aufgeteilt wird. Die "flache" Version besteht nur aus einer Seite pro Top-Level Kapitel. Also 12 Seiten insgesamt. Die "strukturiertere" Version verfügt über jeweils eine Seite für jede Level-2-Überschrift.

Beide Versionen können hier runtergeladen werden:

• Confluence-space-export-7FE7FG.xml.zip
• Confluence-space-export-7SE7SG.xml.zip

How you can import them into your own confluence is described in the Confluence documentationDie Dokumentation, wie dieser Space importiert werden kann, finden Sie in der Confluence Dokumentation: Import a Confluence Space

ProsVorteile:

• easy to do, one space per project

Cons:

• einfach umzusetzen
• ein Confluence-Space pro Projekt

Nachteile:

• Sie benötigen Administrator-Rechte um einen Space importieren zu können
• der Import ist stark abhängig von der Confluence-Version

2) Use one of the Confluence Plugins

2) Benutzen Sie eines der Confluence arc42-Plugins

Im Atlassian Marketplace gibt es zwei Confluence-Plugins, die Sie bei der Dokumentation mit arc42unterstützen:

• Blueprints for arc42
• ATC - arc42 Template for Confluence

Just give them a try

Pros:

• various, depending on plugin

Cons:

• you need to be able to install plugins (not available for cloud instances)

3) Use docToolchain to import the AsciiDoc version yourself

docToolchain is an open source Gradle build which takes an Asciidoc document as input and renders it in various formats. I already works quite well but still lacks some documentation:

Probieren Sie sie einfach mal aus!

Vorteile:

• unterschiedlich, abhängig vom Plugin

Nachteile:

• Sie müssen in Ihrer Confluence-Instanz Plugins installieren können (die Plugins sind z.B. nicht für die Cloud-Instanzen verfügbar)

3) Importieren Sie arc42 mit docToolchain

docToolchain ist ein open source Gradle-Projekt mit dem sich AsciiDoc Dokumente leicht in verschiedene Ausgabeformate wandeln lassen. Das Projekt funktioniert recht gut, ist aber noch nicht sehr gut dokumentiert:

1. laden Sie das Gradle-Projekt von Github runter: https://github.com/rdmueller/docToolchain/archive/master.zip
   it already comes with arc42 "preinstalled" and the gradle-wrapper. So the only requirement is a working java installationconvert the Asciidoc arc42-template to htmlEs enthält schon das arc42-Template vorinstalliert und enthält den Gradle-Wrapper. Somit benötigt es nur eine funktionsfähige Java-Version zum Laufen.
2. konvertieren Sie das Asciidoc arc42-template nach HTML:
   ./gradlew
   this creates the html version of the template within the build-folderconfigure your confluence access:
   open die HTML-Version liegt anschliessend im build-Verzeichnis
3. konfigurieren Sie Ihren Zugriff auf Confluence:
   öffnen Sie die Datei./scripts/ConfluenceConfig.groovy and edit this config according to your needs and setup.publish the arc42-template via the und ändern Sie die Konfiguration entsprechend Ihren Wünschen und Ihrem Setup.
4. Importieren Sie das arc42-Template über die Confluence REST-API directly to your Confluence spacedirekt in Ihren Confluence-Space
   ./gradlew publishToConfluence
5. start to write your documentation with Confluence as master

If you want to stay updated about the progress of docToolchain, just follow the twitter account @docToolchain. If you need help, please use the github issue-tracker.

Pros:

• you can have several copies of the template in one Confluence by prefixing the pages with (for example) a project key
• you don't need to have the admin role

Cons:

• very technical

4) Use docToolchain to only publish to Confluence

With docToolchain lets you not only immport the template to Confluence, but it also allows you to use AsciiDoc as your master document. Just follow the steps above and start to write your documentation within the ./src/docs folder of the Gradle build. Everytime you want to publish your document to Confluence, run the standard Gradle build followed by ./gradlew publishToConfluence - only changes will be published.

1. schreiben Sie Ihre Architekturdokumentation mit Confluence als Master

Wenn Sie bezüglich der Weiterentwicklung von docToolchain auf dem Laufenden bleiben wollen, können sie dem Twitter-Account @docToolchain folgen. Benötigen Sie Unterstützung, stellen Sie bitte entsprechende Problembeschreibungen im Github Issue-Tracker ein.

Vorteile:

• durch ein Präfix der Seitennamen können mehrere Kopien des Templates in einem Confluence-Space verwaltet werden
• der Vorgang benötigt keine Admin-Rechte

Nacheile:

• sehr technisch

4) Benutzen Sie docToolchain zum Export nach Confluence

Mit docToolchain können Sie nicht nur das arc42-Template nach Confluence importieren, Sie können auch das AsciiDoc-Template als Master verwenden. Befolgen Sie einfach die unter 3) beschriebenen Schritte und schreiben Sie Ihre Dokumentation in Asciidoc im./src/docs - Verzeichnis des Gradle-Projekts. Immer wenn Sie anschließend die Dokumentation in Confluence updaten wollen, können Sie die AsciiDoc-Dokumentation exportieren, indem Sie

.gradlew

gefolgt von

./gradlew publishToConfluence

ausführen.

Vorteile:

• Docs-as-Code approach: use the same mechanisms for your documents as you use for your code
• use PlantUML for diagrams withouth having to install the Confluence plugin
• use all features of AsciiDoc together with the benefits of Confluence (watchers, comments etc.)

Cons:

• even more technical
• does not come with an easy to use editorAnsatz: nutzen Sie die selben Tools für Ihre Dokumentation wie für Ihren Source-Code
• nutzen Sie z.B. PlantUML für Diagramme ohne das Confluence-Plugin installieren zu müssen
• nutzen Sie alle Vorteile von AsciiDoc zusammen mit den Featuresvon Confluence (Seiten beobachten, Kommentare etc.)

Nachteile:

• noch technischer als 3)
• vefügt über keinen Editor wie Confluence