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

Wie beinflusst die Digitalisierung die Arbeit der Technischen Redakteure?

Mit der Digitalisierung ändern sich Produkte, Produktionsprozesse und das Nutzungsverhalten. Daraus resultieren neue Anforderungen an die Arbeit der Technischen Redakteure. mehr ...

Vom Geisteswissenschaftler zum Technischen Redakteur

"Und, was willst du machen, wenn du fertig bist?" Welcher Student kennt diesen Satz nicht? Besonders Geisteswissenschaftlern fällt es oft schwer, auf die Frage eine zufriedenstellende Antwort zu finden. Der deutsche Arbeitsmarkt sucht schließlich Elektroingenieure oder Informatiker und keine Historiker mit Spezialisierung auf die Antike wie mich. mehr ...

tekom-Jahrestagung 2018: Was gibt’s Neues bei iiRDS?

iiRDS war zentrales Thema auf der tekom-Tagung: das iiRDS-Café, Fachvorträge, Showcases und Tutorials widmeten sich dem neuen Standard. Auch auf Twitter wurde diskutiert, unter anderem über den für US-Kollegen so schwer auszusprechenden Namen. mehr ...

tekom-Bericht Teil 3: Kreativität statt Langeweile – Online-Videos für die technische Doku

Manege auf! Zu Beginn seines Workshops „Packende Online-Videos mit einfachen Mitteln erstellen“ zeigte Stephan Schneider zwei Bilder. mehr ...

tekom-Bericht Teil 2: Über echte und virtuelle Überflieger

Die tekom begrüßt mich mit strahlendem Sonnenschein. Drinnen sind Tagung und Messe bereits in vollem Gange. Zwei Tage Vorträge, Workshops, Messebesuch und Gespräche warten auf mich. mehr ...
  • linkedin
  • xing