Blog

Blog-Empfehlung: Soft-Skills für den Berufseinstieg

Welche Fähigkeiten sollten Berufseinsteiger in der Technischen Redaktion mitbringen? Sprachliches und technisches Verständnis sind in unserem Beruf unabdingbar. Aber auch Soft-Skills sind wichtig – wie in jedem anderen Beruf auch. mehr ...

RDF is not XML – RDF serialization and iiRDS metadata

The world of technical writing loves XML. Its document type definitions are the foundation of structured authoring. XML and the underlying schemas structure the content of our information products. The benefits are twofold. Content is consistently structured and easy to read. Authors have an easier time writing the content. The structure provides guidelines for authoring. mehr ...

How to become a technical writer – Confessions of a former translator

A former translator, I worked the first seven years of my professional life in the translation industry, in various positions. While I learned a lot from this experience, it also left me, as a writer, frustrated. Translators are chained to their source text and writing the words of others in another language, usually focusing on what their clients want. mehr ...

tekom-Impressionen Teil 2: API-Dokumentation und die VUKA-Welt

Daniela Herbold und Ulrike Parson berichten über Leitlinien für eine optimierte API-Dokumentation sowie Lösungsansätze für eine innovative Personalführung. mehr ...

tekom-Impressionen Teil 1: Improvisationstechniken, Fluff Hunt und Videos

Auf dem Weg zur Konferenz sehe ich an der Fassade des Stuttgarter Bahnhofs ein Zitat von Hegel: „daß diese Furcht zu irren schon der Irrtum selbst ist“. Genau darum ging es in Anthonys Apodacas Vortrag am Morgen des zweiten Konferenztages. 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