Blog

Check if oder check that? Oder: Have you tried turning it off and on again?

Wie oft schreiben oder lesen wir in Anleitungen, dass wir etwas prüfen sollen. Beispiel: "Check if the computer is connected to power." Klare Ansage, alles schön. Was aber, wenn dort steht: "Check that the computer is connected to power"? mehr ...

Hoher Qualitätsanspruch ohne mentale Sandburgen und Dünkel - 10 Fragen an Ines Lasch

Ines Lasch macht eine Weiterbildung zur Technischen Redakteurin und absolviert ein achtwöchiges Praktikum bei parson. Wir haben ihr zehn Fragen gestellt. mehr ...

Volontariat für Technische Redakteure. Zwei Sichten auf die berufsbegleitende Ausbildung

Anja Schiel, Volontärin, und Ulrike Parson, Vorstand der parson AG, berichten über ihre Sicht des Volontariats für die Technische Redaktion.* mehr ...

Machen Sie Ihre technische Dokumentation intelligent – der Weg vom Content Management zu Content Delivery

In diesem Beitrag möchten wir Ihnen aufzeigen, wie man CDPs mit technischer Dokumentation so intelligent befüllt, dass die Nutzer schnell und gezielt Antworten auf ihre Fragestellungen bekommen. mehr ...

So funktioniert Mentoring bei parson

Die Bewerbung ist verschickt, das Vorstellungsgespräch war erfolgreich, jetzt kommt die Zusage. Und da ist er schon, der erste Arbeitstag, an dem alles so fremd ist: Kollegen, deren Namen man sofort wieder vergisst, Ablagestrukturen, Prozesse, ERP-System. Nicht mal die Kaffeemaschine funktioniert auf Anhieb. Und wo war noch mal der Besprechungsraum? mehr ...

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


  • facebook
  • linkedin
  • xing