Willkommen 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:
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:
Sie können die Bereich aber auch jederzeit selbst exportieren - der anonyme User verfügt über die entsprechenden Berechtigungen.
Die Dokumentation, wie dieser Space importiert werden kann, finden Sie in der Confluence Dokumentation: Import a Confluence Space
Vorteile:
Nachteile:
Möchten Sie Ihre Dokumentation veröffentlichen? In dieser Confluence-Instanz ist noch viel Platz - kontaktieren Sie uns einfach! |
Im Atlassian Marketplace gibt es zwei Confluence-Plugins, die Sie bei der Dokumentation mit arc42unterstützen:
Probieren Sie sie einfach mal aus!
Vorteile:
Nachteile:
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:
./gradlew
build
-Verzeichnis./scripts/ConfluenceConfig.groovy
und ändern Sie die Konfiguration entsprechend Ihren Wünschen und Ihrem Setup../gradlew publishToConfluence
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:
Nacheile:
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:
Nachteile:
PS: an dieser Stelle ein großes Dankeschön and Atlassian für die Bereitstellung dieser Confluence-Instanz! |