AutoPage goes Cloud – die einfachste Lösung für dein “Doku-Problem”

Read this article in English

AutoPage Cloud - einfache automatisierte Dokumentationen aus Jira-Issues erstellen

Dokumentation gilt nicht gerade als Lieblingsbeschäftigung von Software-Entwickler*innen, weil es sie von den "wirklich wichtigen Sachen" – wie dem Schreiben von tollem Code – abhält. Doch auch über diese Gruppe hinaus gilt: Wer dokumentiert schon gerne? Keine Frage, Dokus sind essenziell, doch auch zeitaufwendig, gerade weil sie verständlich, umfänglich und vor allem aktuell sein sollten. Insbesondere der letzte Punkt kann schnell zu einer wahren Herausforderung werden. Wäre es daher nicht schön, wenn man das Dokumentieren einfach automatisieren und zudem noch sicher sein könnte, dass das fertige Machwerk stets aktuell bleibt?

Für Atlassian-Nutzer*innen, die mit Jira und Confluence arbeiten, kommt die Lösung in Form einer App daher: AutoPage.

AutoPage erstellt nicht nur voll automatisiert Confluence-Seiten auf Basis definierter Regeln in Jira-Issues, sondern synchronisiert die Inhalte auch bidirektional. Dabei lässt sich jede Confluence-Seite als Template benutzen. Bislang gab es AutoPage nur für Server- und DataCenter-Installationen. Jetzt ist die App endlich auch als Cloud-Version verfügbar, kompatibel mit Jira und Confluence Cloud. Du kannst sie dir einfach auf dem Atlassian Marketplace herunterladen und einen Monat ausprobieren.

AutoPage Cloud - Doku auf Confluence-Seiten direkt aus Jira-Issues

Deine Vorteile mit AutoPage Cloud

Immer up-to-date – weil die Dokumentation entsteht, während du noch in Jira arbeitest. Durch die bidirektionale Synchronisation musst du deine Daten und Änderungen nicht in zwei Systemen pflegen. Überdies werden Fehler und Inkonsistenzen vermieden, da alles im gleichen Ökosystem läuft.

Zeitersparnis – denn du kannst deine Templates direkt mit dem Confluence-Editor erstellen.

Einheitliches Look-and-feel – durch die standardisierten Vorlagen erhält deine Doku ein einheitliches Look-and-feel. Das macht sie leichter lesbar und du kannst sie problemlos mit externen Partnern teilen.

Automatisierte Prozesse – stelle einfach in Jira ein, zu welchem Zeitpunkt eine Dokumentationsseite angelegt werden soll. Dafür definierst du die entsprechende Regel nur ein einziges Mal, danach erledigt AutoPage die Arbeit für dich.

Effizienteres Arbeiten – AutoPage erzeugt Links zwischen deinen Confluence-Seiten und Jira-Issues. So kannst du reibungslos und schnell zwischen den Systemen hin- und herwechseln.

So einfach funktioniert AutoPage

Tatsächlich sind nur zwei Schritte notwendig, um zu deiner automatisierten Dokumentation zu kommen:
1. Erstelle ein Template in Confluence, das als Vorlage für zu erstellende Seiten dient.
2. Erstelle eine AutoPage-Automatisierungsregel in Jira, die definiert, wann und mit welchen Parametern eine Confluence-Seite zu einem Jira-Issue angelegt werden soll.

Ein Template anzulegen ist denkbar einfach: Die Seite wird wie eine gewöhnliche Confluence-Seite erstellt. Dort, wo Daten aus einem Jira-Issue in der Confluence-Seite angezeigt werden sollen, kommen die AutoPage-Makros ins Spiel:

  • Für Textblöcke, z. B. die Beschreibung im Issue, nutzt du das "Block Macro".
  • Das "Inline Macro" hingegen dient dazu, einzelne Felder wie Reporter, Assignee, Status, Priority usw. anzuzeigen.

So kannst du dir ganz nach Belieben Vorlagen für Dokuseiten zusammenbauen, die alle notwendigen Infos enthalten.

Fehlt nur noch Schritt 2, die Automatisierungsregel: Diese kannst du einfach in Jira definieren. So entstehen aus dem Template und den Daten aus Jira Dokumentationsseiten aus einem Guss. Und das Beste: Ändert sich etwas im Jira-Issue, seien es der Status, die Beschreibung oder sonstiges, werden die Änderungen auf der Confluence-Seite synchronisiert!

AutoPage Cloud ist einfach zu konfigurieren

Nicht nur für Doku-Muffel

Wer bereits mit Confluence und Jira arbeitet, weiß, dass sich beide Anwendungen für ganz unterschiedliche Fälle eignen. Das Gleiche gilt auch für AutoPage: Wenn ein Team beispielsweise gerade eine User Story realisiert hat, kann es mithilfe von AutoPage sofort die Dokumentationsseiten dazu anlegen. Oder man nutzt z. B. Kundenanfragen als Basis für Wissensartikel – das ist mit AutoPage einfach umsetzbar.

Die App macht Software-Entwickler*innen das Leben ebenfalls etwas leichter – denn damit können Dokus zu Stories oder Bugs voll automatisiert erstellt werden. Aber auch dann, wenn detaillierte Dokumentationen oder Reports gefragt sind, sei es bei Behörden, in der öffentlichen Verwaltung oder auch im Projekt- oder Produktmanagement, leistet AutoPage hervorragende Dienste.

Erlebe AutoPage Cloud “in action”

Wir zeigen dir gerne, wie AutoPage funktioniert und wie du deine individuellen Doku-Herausforderungen damit meistern kannst! Buche einfach einen Demo-Termin bei uns!  Dabei können wir natürlich auch alle eventuellen Fragen klären.

Spare dir zukünftig Zeit, Geld und Kopfarbeit und setze auf automatisierte Dokumentation. Hol dir AutoPage Cloud!

 

Weiterführende Infos

Die Übersichts-Dokuseite für AutoPage
Die Dokumentation für AutoPage Cloud findest du unter diesem Link
Pimpe deine (mit AutoPage erstellten) Confluence-Dokumentationen mit dem Seitenbaukasten von Karma
AutoPage in action in Agile Hive