Agil dokumentieren

Mit cards+ wird inkrementelles Doku­men­tieren in einem agilen Software-Entwicklungsprozess zur leist­baren Auf­gabe. Die Doku­men­te werden prüf­bar, die Quali­tät mess­bar.

Doku­men­tieren ist ein Reiz­wort in der agilen Soft­ware-Ent­wick­lung.

Agile Soft­ware-Ent­wick­lung ist Teil der digi­talen Trans­for­mation in vielen Unter­neh­men. Dabei kommt es aber nicht nur darauf an, agil vor­zu­gehen, son­dern gene­rell agil zu werden. Agili­tät wird häu­fig in einem Atem­zug mit Ge­schwin­dig­keit oder Effi­zienz ge­nannt. Aber über Doku­men­tation wird nicht so häu­fig ge­spro­chen. Es gibt die einen, die auf Doku­men­tation ver­zich­ten wollen. »Code und Test­pläne reichen!«, sagen sie. Andere wollen wiede­rum alles ganz genau auf­schrei­ben. »Das Wissen darf nicht ver­loren gehen!«, for­dern sie.

In diesem Span­nungs­­­­feld bewegt sich cards+. Wir schätzen funktio­nierende Soft­ware, aber wir wollen auch eine leben­dige Doku­men­tation für die Soft­ware. Sie um­fasst ver­schie­dene Arten pro­dukt­bezo­gener doku­men­tier­ter Infor­matio­nen, die für unter­schied­liche Zwecke ge­braucht oder ge­for­dert werden. Mit cards+ set­zen Sie auf eine Methode zum inkre­men­tellen Ent­wickeln sol­cher Doku­men­te in einem Wiki.

Doku­men­tie­ren erfor­dert wie Pro­gram­mie­ren viel Krea­tivi­tät und hand­werk­liches Ge­schick. Ein­fache Regeln und klare Struk­turen stei­gern so­wohl die Quali­tät der Er­geb­nisse als auch Pro­duk­tivi­tät ihres Ent­wick­ler-Teams. Der Gärt­ner ist als Coach für Auto­ren und Le­ser immer greif­bar und hilft bei der Be­wälti­gung von all­täg­lichen wie auch spe­ziel­len Prob­lemen im Zu­sam­men­hang mit der Doku­men­tation.

Mehr erfahren

Doku­men­tie­ren erfordert wie Pro­gram­mie­ren konti­nuier­liche Ver­besserung. Viele bekannte Prin­zipien und Prak­tiken der Ent­wick­ler kön­nen Auto­ren im Wiki direkt (z.B. KISS, DRY oder INVEST) oder in nur leicht abge­wan­del­ter Form (z.B. SRP) an­wen­den. Ein Gärt­ner ist Ex­per­te im Zusam­men­hang mit Dok­umen­tation. Er sorgt für die For­mulie­rung und Durch­setzung von Doku­men­tations­richt­linien (wie die Pro­gram­mier­richt­linien für Ent­wick­ler).

Mehr erfahren

Domain-Driven Design ist ihr favori­sier­ter Ansatz für die Analyse.

Sie nutzen Domain-Driven Design für strate­gisches und takt­isches Design in ihren Ent­wick­lungs­pro­jek­ten. Ihre Domänen­exper­ten stellen die Modellie­rung der Fach­lich­keit in den Vorder­grund und erschaf­fen eine domänen­spezi­fischen Sprache. Jeder kennt sie, jeder spricht sie, egal ob als Ent­wickler, Tester oder Nutzer betei­ligt ist.

Trifft das zu, dann haben sie opti­male Voraus­setzun­gen für einen erfolg­rei­chen Ein­satz von cards+ zur Doku­men­tation der Ergeb­nisse aus dem stra­tegi­schen und tak­ti­schen Design im Wiki.

Mehr erfahren

Agile Soft­ware-Ent­wick­lung mit Scrum ist ge­lebte Reali­tät in ihren Pro­jek­ten.

Sie setzen auf Scrum zur Organi­sation ihrer agilen Ent­wick­lung. Der An­satz von Scrum ist empi­risch, inkre­men­tell und itera­tiv. Schritt für Schritt wird ihr Team besser und schneller. Selbst­organi­siert. Maxi­mal Moti­viert. Ihr Fokus liegt auf Quali­tät und Exzel­lenz. In kur­zen Zyk­len ent­wickeln Sie kunden­wirk­same Inkre­mente.

Möchten sie ihren Fort­schritt nach­haltig sicht­bar machen und jedes Inkr­ement ange­messen doku­mentie­ren, dann inte­grie­ren sie cards+ in ihren Pro­zess und nutzen ein Wiki für ihre Doku­men­tation.

Mehr erfahren

Der Reise-Butler.
Ein Fall­bei­spiel.

Doku­mente agil und itera­­tiv ent­wickeln.

Mit dem Ein­satz von cards+ ist jede agile Pro­jekt­organi­sation in der Lage, ziel­gerich­tet und itera­tiv eine Pro­dukt­doku­men­tation zu ent­wickeln. Ziel­gerich­tet bedeu­tet, dass die erstell­ten Doku­mente einen Wert für die Organi­sation haben. Itera­tiv bedeu­tet fort­laufende Wieder­holung, ver­bun­den mit der Chance, sich Schritt für Schritt zu ver­bessern. Mit dem Fort­schritt in der Ent­wick­lung der Soft­ware wächst auch die Pro­dukt­doku­men­tation, als inte­gra­ler Bestand­teil des Pro­dukt­inkre­men­tes. Doku­men­tieren wird zur leist­baren Auf­gabe des gesam­ten Teams. Die Doku­men­tation wird prüf­bar, die Quali­tät mess­bar.

Methode

Agil zu doku­men­tieren heißt bedarfs­­gerecht zu doku­men­tieren.

Prozesse

Tue es oder tue es nicht. Es gibt kein Ver­suchen.

Das Wiki.
Ein Erfolgs­faktor.

Doku­mente inkre­­­­­men­­­­­tell ent­wickeln.

Jedes inkre­­­­­men­­­­­telle Vor­­­­­gehens­­­­­modell basiert auf der Idee der kleinen Schritte zur Reduktion der Kom­­­­­plexi­­­­­tät. In den Inkre­­­­­menten redu­­­­­zieren wir jedes kom­­­­­plexe Pro­­­­­blem in ein kom­­­­­plizier­­­­­tes, manch­­­­­mal sogar offen­­­­­sicht­­­­­liches Pro­­­­­blem. Damit machen wir ein kom­­­­­plexes Pro­­­­­blem be­­­­­herrsch­­­­­bar. Als agile Methode profi­­­­­tiert cards+ von den Erkennt­­­­­nissen aus der inkre­­­­­men­­­­­tellen Ent­­­­­wick­­­­­lung und nutzt die Vor­­­­­teile konti­­­­­nuier­­­­­licher Ver­­­­­besserung für die Doku­men­tation.

Methode

Es ist ein­facher, einer Hand­voll kleinerer Heraus­forderun­gen zu bege­gnen als einer einzel­nen großen.

Struk­tur

Das Prob­lem zu erken­nen, ist wich­tiger, als die Lösung zu erken­nen.

Das Meta­modell.
Ein Überblick.

Doku­mente wie Quell­text ent­wickeln.

Ascii­doc ist eine leicht­­gewich­t­ige Aus­­zeich­nungs­­sprache für eine text­­basierte Doku­­menten­­generie­rung. Eine Ascii­doc-Datei kann u.a. in die For­­mate HTML5, EPUB3 und PDF umge­wan­delt werden. Eine Preview für Ascii­doc-Dateien ist als Zusatz prak­tisch in jeder IDE ver­füg­bar. Eine Ascii­doc-Datei kann wie Quell­­text inkre­men­tell ent­wickelt und im Code-Reposi­tory ver­sio­niert gespei­chert wer­den. Damit kann ein großer Teil der Pro­dukt­doku­men­tation durch auto­matisier­bare Ver­öffent­lichung im Wiki direkt aus der Code-Basis in den Bau­steinen von cards+ inte­griert werden.

Methode

Soft­ware ist nichts ande­res als aus­führ­bares Wissen.

Quali­tät

Quali­tät ist das Er­geb­nis einer Viel­zahl selbst­loser Akte der Sorg­falt.

Asciidoc(tor).
Für Qualität.

Von den Anfän­gen bis heute.

Ein im Jahr 2014 gestar­tetes agiles Ent­wick­lungs­pro­jekt hatte das Ziel, das IT-System der Trans­port­leitungen der Deutschen Bahn zu moderni­sieren. Die dort gewon­nenen Erkennt­nisse führ­ten zum ersten Ent­wurf von cards+ als Ansatz für inkre­men­telles Doku­men­tieren.

Die Deutsche Bahn nutzt cards+ seit 2016 als Vor­lage für einen pro­jekt­­spezi­fischen An­satz für inkre­men­telles Doku­men­tieren im agilen Ent­wick­lungs­pro­zess für ein neues IT-System zur Reisen­den­infor­mation.

Sortimo Inter­natio­nal GmbH hat ihr Pro­dukt­portfolio in 2018 erwei­tert und geht mit dem Bekle­bungs­konfi­gura­tor in den Markt. Für die Doku­men­tation der Pro­jekt­ergeb­nisse wurde cards+ als Ergän­zung zum agilen Ent­wick­lungs­pro­zess gewählt.

Bis heute ist cards+ Teil der Quali­täts­poli­tik der Firma e.mundo.

Auf­grund der Vor­gaben der DS-GVO möchte ich als Ver­ant­wort­licher für den Inhalt keine Kommen­tar­funk­tion anbie­ten. Wer Fra­gen hat oder ein­fach nur Feed­back zu cards+ geben möchte, kann das sehr gerne in der moderier­ten Gruppe Agil doku­men­tie­ren im sozia­len Netz­werk Xing tun.

Feedback geben