Agile Dokumentation – funktioniert das?

Das Stichwort agil ist in der Softwareentwicklung mindestens so beliebt wie DITA in der Technischen Dokumentation. Kein Wunder: Agil und DITA konzentrieren sich auf Modularisierung und die Anforderungen der Nutzer.

Scrum-Projekt. Quelle: parson AGScrum-Projekt. Quelle: parson AGMarion Knebels Artikel zu agiler Dokumentation wurde in der Zeitschrift Dokuworld, Ausgabe 1-2017, veröffentlicht. Der Artikel beleuchtet, wie agiles Dokumentieren in der Praxis funktioniert. Sie finden den Artikel hier als PDF und auf unserer Website.

Kommentare   

# Henning S. 2017-05-07 15:04
Richtig praktiziert kann agiles Dokumentieren sehr gut funktionieren und auch die Ergebnisse sind mMn besser als in anderen Sw-Entwicklungsprozessen. Bleibt die Frage nach den Tools: DITA oder vielleicht doch lieber Confluence oder Markdown mit einem statischen Site-Generator?
Antworten
# Marion Knebel 2017-05-08 10:42
Ich stimme vollkommen zu, dass das Dokumentieren in agilen Umgebunen sehr gut funktionieren kann. Die Frage nach den Tools sehe ich aber eher losgelöst davon. Pauschal gibt es da m.E. keine richtige Antwort. Die Auswahl des Tools muss sich aus den individuellen Anforderungen ergeben. Wenn Sie z.B. viel Übersetzungsbedarf haben und Sie viele Varianten benötigen, werden Sie mit Confluence oder Markdown nicht weit kommen und benötigen am Ende vielleicht sogar ein Redaktionssystem. Wenn Sie andererseits entwicklernahe Dokumentation haben und die Entwickler selbst an der Dokumentation mitarbeiten sollen, kann man auch mit Markdown schöne Sachen machen (oder aber Markdown-Content in DITA integrieren). Möglichkeiten gibt es am Ende viele und alle (na ja, die meisten :) habe ihre Berechtigung. Für welches Tool haben Sie sich entschieden und warum?
Antworten
# Henning S. 2017-05-08 18:12
Die Frage könnte auch lauten: Eignen sich manche Tools besser als andere für das agile Dokumentieren? Tendenziell sehe ich einige Vorteile bei schlanken Tools (Wiki, Markdown). Richtig ist aber natürlich auch: Die Deliverables (z. B. mehrere Varianten, unterschiedliche Ausgabemedien, mehrere Sprachen) können es erfordern, andere Tools zu verwenden. Es kommt also auf den Einzelfall an. Framemaker funktioniert für mich ganz gut, agil ebenso wie vorher bereits klassisch.
Antworten

Kommentar schreiben


Blog

Über Lampen, Birnen und Fluchtinstinkte. Nachschlag zur tekom-Tagung 2019

Im letzten Teil unserer tekom-Nachlese gehts um Erleuchtungen in einem Terminologieworkshop und Fehlermeldungen, die den Fluchtinstinkt in uns wecken. mehr ...

KI als Chance oder Bedrohung für den Technischen Redakteur? Bericht von der tekom-Tagung, 3. Teil

Der Begriff Künstliche Intelligenz (KI) ist ein Phantom. Jeder Mensch assoziiert sofort etwas damit, doch die Vorstellungen sind selten deckungsgleich. mehr ...

Sprung ins kalte Wasser oder wie ich das erstmal Mal slammte. Bericht von der tekom-Tagung, 2. Teil

Eigentlich bin ich ja ein alter Hase bei der tekom-Tagung und sollte nicht mehr allzu aufgeregt sein, wenn ich einen Vortrag halte. Aber als Dieter Gust und ich unsere Feierabend-Schnapsidee einer scherzhaften Debatte (Trend-Slam) auf die Bühne brachten, war mir doch etwas flau im Magen. Wie würde das wohl ankommen? mehr ...

Der-die-das, drei Redakteure gehen essen und ein Könjunktiv. Bericht von der tekom-Tagung, 1. Teil

Eine Referentin irritierte mich, weil sie konsequent von "dem" Engine sprach, der in der Software für die maschinelle Übersetzung zuständig ist. Ich benutze bei Engine immer "die".  mehr ...

Der iiBot gibt Anweisung

Ein Chatbot, der dem Servicetechniker genaue Anweisungen für seine akute Fragestellung gibt – live, anwendungsgerecht und zugeschnitten auf die Qualifikation des Servicetechnikers. mehr ...
  • linkedin
  • xing