Agile Software-Dokumentation

Agile Software-Doku

Wenn man Technische Doku für Software schreibt, hat man es oft mit agil organisierten Teams zu tun. Das bedeutet häufig, dass einzelne Bereiche eines Produkts pro Team entwickelt und auch dokumentiert werden. Dieser Ansatz unterscheidet sich natürlich stark von der Dokumentation im Maschinenbau, wie geht man also in der Technischen Redaktion am besten damit um? Auf dieser Seite zu agiler Software-Doku finden Sie hilfreiche Informationen rund um das Thema, damit Sie sich so schnell wie möglich auch im agilen Umfeld zurechtfinden.

Agile Software-Entwicklung - essenziell für mehr Geschwindigkeit

Wieso arbeiten Software-Hersteller so oft agil?

In der Software-Entwicklung geht es um Geschwindigkeit, also um die Zeit bis ein für Kunden wertvolles Produkt auf dem Markt ist. Ist das Produkt einmal da, hört dieser Anspruch aber nicht auf. Das Produkt wächst kontinuierlich weiter um neue Funktionen, Sicherheits-Updates und dergleichen. Es ist also nie wirklich so fertig wie es eine Maschine beispielsweise bei Auslieferung sein muss. Anforderungen und die digitale Welt, in der sich digitale Produkte nun mal befinden, entwickelt sich stets weiter. Diesem Umstand passen sich Software-Entwicklungen durch die agile Methode an. Sie sammeln neue Anforderungen, formulieren diese in sog. Stories um, priorisieren sie, und bauen dann in Teams bestehend aus Entwicklern, Testern und Agile Writers in sog. Sprints die beste Lösung für genau diese Anforderung.

Unsere Videos zum Thema

Agile Software-Doku bei Adcubum

Im Zweifel fragt man am besten beim Profi nach und wer ist hier besser geeignet als ein Documentation Lead der Software-Spezialisten Adcubum? Sven Schmitt berichtet aus der Praxis, was es heißt, in einem agilen Umfeld Technische Doku zu schreiben.

Agile Software-Doku mit SCHEMA ST4

In diesem Webinar erfahren Sie, wie diese nach einem Redaktionssystem für Adcubum verlief, welche Anforderungen der Software-Hersteller dabei konkret hatte und wie diese vom gefundenen CCMS erfüllt werden konnten.

Das Video: UX Writing

Technische Redaktionen am Entwicklungsprozess zu beteiligen, ist nicht die einzige Möglichkeit: UX Writing ist die Disziplin, Software-Texte so zu gestalten, dass sie für User so verständlich wie nur möglich ist. Sie erfahren im Video zu UX Writing außerdem:

Was UX Writing ist
Was für gutes UX Writing spricht
Welche Qualitäten gute UX Writer mitbringen

Unser Podcast "Die Doku-Lounge": Folge 8 über Agile Software-Doku

In unserem Podcast "Die Doku-Lounge" dreht sich alles rund um die Technische Redaktion. In jeder Folge lädt Kerstin Berke Profis aus der Branche ein, um ein Thema genauestens unter die Lupe zu nehmen. In dieser Folge hat sie sich mit Sven Schmitt, Documentation Lead beim Software-Spezialisten Adcubum, über agile Software-Doku unterhalten. Wir wünschen Ihnen viel Spaß!

Fachtexte zum Thema

Ungleiche Geschwister: Technische Redaktion und Marketing

Im Prinzip machen Technische Redaktion und Marketing ja das Gleiche: Sie kommunizieren mit den Kunden über die Produkte des Unternehmens. Die Metapher von den „Geschwistern“ ist deshalb durchaus berechtigt.

Zum Artikel

3D-Daten in der Technischen Doku?

Nachdem doch sehr viel für die dreidimensionalen Darstellungen spricht– neben einigen wenigen Problemen, wollen wir uns nun einmal genauer ansehen, wie man an brauchbare Daten gelangt und was bei der Erstellung von 3D-Modellen zu beachten ist.

SCHEMA ST4 im Web

Ohne Redaktionssystem kommt eine Technische Redaktion oft nicht aus. Wäre das jetzt noch im Web, könnte man flexibel von überall und mit jedem Endgerät damit arbeiten. Was spricht noch dafür?

Zum Artikel

Mit SCHEMA ST4 geht das noch besser!

Lernen Sie unser Redaktionssystem SCHEMA ST4 jetzt kennen.

Video: SCHEMA ST4 in 25 Minuten