Schlank dokumentieren mit Jira und Confluence
Mit möglichst wenig Aufwand genau die Informationen eines Systems festhalten, welche das Verständnis und die Weiterentwicklung des Systems unterstützen.
Für wen ist diese Art der Dokumentation geeignet?
- Euer Team arbeitet mit Jira und Confluence.
- Die Funktionalitäten Eurer Systeme sind zwar dokumentiert, aber leider ist es schwierig, die richtige Wiki-Seite zu finden?
- Ihr wünscht Euch einen Ansatz, mit dem die richtige Wiki-Seite intuitiv gefunden wird und zwar nicht nur vom Ersteller.
- Ihr möchtet die fachlichen Zusammenhänge festhalten, damit das Systemverhalten nicht jedesmal wieder zusammen mit dem Entwickler durch Reverse Engineering ermittelt werden muss.
- Ihr seid der Meinung, dass weniger oft mehr ist.
Präsentation
Wir präsentieren vor Ort bei Ihnen unseren Lean Documentation Ansatz, so wie er sich bei unseren Kunden bewährt hat. Der Ansatz wurde für Webapplikationen basierend auf Microservices und Legacy Server Systemen optimiert, die von Dutzenden von global verteilten, agilen Entwicklungsteams weiterentwickelt werden.
Es wird aufgezeigt, wie mit Jira-Labels, verschiedenen Confluence-Filtern, Draw.io-Diagrammen und Templates aus Wiki-Seiten eine schlanke, strukturierte Systemdokumentation entsteht.
Wie läuft es ab?
Präsentationsdauer: 90min
Kosten: 290 CHF
Workshop
Die Erfahrung zeigt, dass es gefährlich ist, einfach eine vorgefertigte Struktur zu platzieren und dann zu erwarten, dass diese von den Mitarbeitern ausgefüllt wird.
Viel motivierender ist es, wenn das Team seine Dokumentationsstruktur selber definiert und das gesamte Team festlegt, welche Informationen festgehalten werden sollen und vor allem auch weshalb.
Auf diese Weise ist sichergestellt, dass die Dokumentation das enthält, was das Team auch möchte, bereit ist zu pflegen und im Anschluss auch von jedem Teammitglied erwartet.
Unser Workshop-Moderator unterstützt Ihr Team beim Finden der optimalen Dokumentationsstruktur und führt die Diskussionen so, dass alle wichtigen Punkte für eine professionelle aber dennoch schlanke Systemdokumentation berücksichtigt werden.
Wie läuft es ab?
Workshopdauer: 120 min
Kosten: 490 CHF
Setup
Sind die gewünschten Dokumentations-Artefakte gefunden und die Struktur definiert, gilt es die Templates in Confluence zu erstellen und alle Filterkomponenten korrekt zu konfigurieren. Unser Experte übernimmt diese Arbeit für Sie, damit Ihr Team baldmöglichst mit der neuen Dokumentation beginnen kann.
Wie läuft es ab?
Vorbedingung:
Die Dokumentationsartefakte und Verlinkungsstruktur wurden im Workshop bereits definiert.
Kosten: 2990 CHF
Coaching
Obwohl der Dokumentationsansatz sehr simple und intuitiv verständlich ist, zeigt sich in der Praxis, dass oft Fragen bezüglich des Inhalts aufkommen. Welcher Inhalt ist es Wert, aufgeschrieben zu werden? Weniger ist oft mehr, aber wie viel genau ist optimal?
Unser Experte vor Ort bei Ihnen begleitet Ihr Team und steht für Fragen dieser Art zur Verfügung. Zusätzlich plant und moderiert unser Experte ein Bi-Weekly Meeting, in dem die einzelnen Fragestellungen zusammengefasst und mit dem Team diskutiert werden. Dies dient dem Know-how-Transfer im Bezug auf den Dokumentationsansatz und fördert auch das Verständnis der Systemfunktionalität für alle Teammitglieder.
Wie läuft es ab?
Ca. einen Tage pro Woche steht unser Experte Ihrem Team für Fragen zur Verfügung.
Gewünschte Anpassungen am Dokumentationsansatz und den entsprechenden Konfigurationen in Jira/Confluence werden konfiguriert.
Kosten: Auf Anfrage
Agile requirements engineer
Eine gute Idee für einen Dokumentationsansatz ist nicht das Einzige, das fehlt?
Sie benötigen jemanden, der Ihren Product Owner unterstützt und die Bedürfnisse aller Stakeholder zusammenträgt, analysiert, abstimmt und user stories erstellt?
Unser Experte arbeitet zusammen mit Ihrem Team als externer Mitarbeiter und übernimmt die Rolle eines agile requirements engineers. Auf diese Weise lässt sich der Dokumentationsansatz noch besser einführen, weil unser Experte als Vorreiter in der Anwendung des Dokumentationsansatzes fungieren kann.
Wie läuft es ab?
Unser Experte arbeitet zusammen mit Ihrem Team als agile requirements engineer.
Pensum: 40% -100%
Kosten: Auf Anfrage