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.

cards+ ein­fach erklärt
von A bis Z.

Asciidoc

Asciidoc ist eine beliebte text­basierte Aus­zeich­nungs­sprache. Eine Asciidoc-Datei kann durch eine geeig­nete Konver­tie­rung als Spezifi­kation im Wiki ver­öffent­licht werden.

Autor

Die Rolle Autor bezeichnet jede Per­son der Pro­jekt­organi­sation, die Pro­dukt­wissen im Wiki erfasst.

Avro

Avro aus dem Apache-Uni­­ver­sum ist eine von vielen Lösungen für eine sprach­­neu­­trale Daten­­seriali­­sierung. Die Avro-Datei kann direkt als Spezifi­kation im Wiki ver­öffent­licht werden.

Bedien­ober­fläche

Eine Bedien­ober­fläche ist die Schnitt­stelle zwischen dem IT-System und den Nutzern. Das Spek­trum reicht von ein­fachen befehls­orien­tier­ten Schnitt­stellen, über gra­fische Bedien­ober­flächen hin zu intui­tiv mit Fin­gern, Ges­ten oder Spra­che gesteuer­ten Anwen­dun­gen.

Case

Der Bau­stein Case ist das Ergeb­nis der Anfo­derungs­ana­lyse und Teil der System­beschrei­bung einer Pro­dukt­doku­mentation. Er beschreibt eine ein­zelne Fähig­keit der Soft­ware.

COD

Das Prin­zip COD hilft bei der Ver­meidung von Doku­mentation die Kon­vention, dass Titel von Seiten aus dem Wiki sich direkt im Code oder einem Test­plan wieder­finden

DDD

Der vom Eric Evans geprägte Begriff Domain-Driven Design steht für eine Heran­gehens­weise beim Ent­wurf einer Soft­ware mit Elemen­ten der Anwendungs­domäne und einer für die­sen Bereich gel­tenden Uni­versal­sprache.

Decision

Der Bau­stein Decision ist ein Ergeb­nis eines Ent­schei­dungs­pro­zesses und Teil des Archi­tektur­ent­wurfs einer Pro­dukt­doku­men­tation. Er bewer­tet alle betrach­te­te Lösun­gen und begrün­det die Ent­schei­dung.

DOD

Das Prin­zip DOD ist ein Werk­zeug der agilen Soft­ware-Ent­wick­lung zur Schaf­fung von Transpa­renz für den Begriff “fertig”.

Domain

Der Bau­stein Domain ist ein Ergeb­nis der Pro­dukt­ent­wick­lung und Teil der System­struk­tur einer Pro­dukt­doku­mentation. Er repräsen­tiert eine Kontext­grenze (engl. bounded context) inner­halb des IT-Systems.

DRY

Das Prin­zip DRY verfolgt das Ziel, jede unnö­tige Wieder­holungen von Inhalten im Wiki zu ver­meiden.

Entity

Der Bau­stein Entity ist ein Ergeb­nis der Pro­dukt­ent­wick­lung und Teil der System­struk­tur einer Pro­dukt­doku­mentation. Er repräsen­tiert ein wich­tiges Infor­mations­objekt (engl. entity) des IT-Systems.

Epic

Der Bau­stein Epic ist das Ergeb­nis der Anfo­derungs­ana­lyse und Teil der System­beschrei­bung einer Pro­dukt­doku­mentation. bün­delt ver­wandte Fähig­keiten der Soft­ware zu einer Funktio­nali­tät.

Event

Der Bau­stein Event ist ein Ergeb­nis der Pro­dukt­ent­wick­lung und Teil der System­struk­tur einer Pro­dukt­doku­mentation. Er repräsen­tiert ein Nach­richten­objekt (engl. event) des IT-Systems.

File

Der Bau­stein File macht eine Datei im Wiki als Medien­seite verfüg­bar. Er reali­siert das Kon­zept der Medien­biblio­thek.

Gärtner

Die Rolle Gärtner bezeichnet jede Per­son der Pro­jekt­organi­sation, die Experte für die Pro­dukt­doku­mentation ist.

Glossar

Das Glossar ist eine alpha­betisch sor­tierte Samm­lung von Begrif­fen aus Anwen­dungs­domäne, in dem die Soft­ware zum Ein­satz kommt.

Inter­essierte Par­tei

Unter dem Sammelbegriff inter­essierte Par­teien versammeln sich alle Per­sonen, die ein wirt­schaft­liches oder stra­tegi­sches Inter­esse am Pro­dukt haben.

INVEST

Das Prin­zip INVEST hilft bei dem Ver­such, Pro­dukt­­­wissen so kom­pakt und voll­stän­dig wie mög­lich zu ver­mit­teln.

Javadoc

Javadoc ist eine Wer­kzeug aus dem JDK. Ein Java-Doclet kann Informationen aus dem Code in eine Datei expor­tieren. Die exportierte Datei kann als Spezifi­kation im Wiki ver­öffent­licht werden.

KISS

Das Prin­zip KISS hilft bei dem Ver­such, Pro­dukt­­­wissen so ein­fach und ver­ständ­lich wie mög­lich zu ver­mit­teln. Ein­fach­heit ist die Kunst, die Menge nicht getaner Arbeit zu maxi­mieren.

Layout

Der Bau­stein Layout ist ein Ergeb­nis der Pro­dukt­ent­wick­lung und Teil der System­struk­tur einer Pro­dukt­doku­mentation. Er repräsen­tiert einen Teil der Bediener­ober­fläche (engl. user interface) des IT-Systems.

Leser

Die Rolle Leser bezeichnet jede inter­essierte Partei oder Per­son der Pro­jekt­organi­sation, die Pro­dukt­wissen im Wiki benö­tigt.

Link

Der Bau­stein Link ist ein Platz­halter für eine externe Datei. Er reali­siert das Kon­zept der Link­samm­lung.

Markdown

Markdown ist eine von vilen text­basierten Aus­zeich­nungs­sprachen. Eine Markdown-Datei kann durch eine geeig­nete Konver­tie­rung als Spezifi­kation im Wiki ver­öffent­licht werden.

PLA

Das Prin­zip PLA spiegelt sich im Aufbau der Seiten im Wiki wider. Jeder Bau­stein im Wiki hat genau einen Zweck, fest­gelegte Abschnitte und ist das Ergeb­nis eines bestimm­ten Pro­zesses.

Pro­dukt

Das Pro­dukt ist das kunden­wirksam ein­geführ­te Pro­dukt­inkre­ment. Es ist gleich­zeitig die Vision für zukünf­tige Pro­dukt­inkre­mente.

Pro­dukt­doku­mentation

Eine Pro­dukt­doku­mentation umfasst Doku­mente, die den Zustand eines Pro­dukt­inkre­ment in einem Wiki beschrei­ben.

Pro­dukt­inkre­ment

Ein Pro­dukt­inkre­ment ist eine lauf­fähige, getes­tete, ange­messen doku­mentierte und gemäß einer DOD über­prüfte und frei­gege­bene Ver­sion des Pro­duktes.

Pro­dukt­ver­antwort­licher

Der Pro­dukt­ver­antwort­liche ist Hüter der Vision des Pro­duktes. Er ist Ansprech­part­ner für inter­essierte Par­teien für Ver­ände­rungen des Pro­duktes.

Pro­jekt­doku­mentation

Eine Pro­jekt­doku­mentation umfasst Doku­mente, die der Pro­dukt­verant­wort­liche oder sein Team für die Planung und Steuerung von Ver­änderungen am Pro­dukt benöti­gen.

Pro­jekt­organi­sation

Eine Pro­jekt­organi­sation umfasst alle Per­sonen, die in einem Ent­wicklungs­proj­ekt an der Ver­änderung des Pro­duktes zusam­men­arbei­ten.

Seite

Ein Seite ist ein im Wiki dauer­haft hinter­legte doku­mentierte Info­mation. Ein Seite hat einen Titel und eine feste Struk­tur.

Seiten­vor­lage

Eine Seiten­vor­lage wird ver­wendet, um im Wiki eine Seite ent­sprechend der Defini­tion des gewähl­ten Bau­steins von cards+ anzu­legen.

Service

Der Bau­stein Service ist ein Ergeb­nis der Pro­dukt­ent­wick­lung und Teil der System­struk­tur einer Pro­dukt­doku­mentation. Er repräsen­tiert einen Dienst (engl. service) des IT-Systems.

SLA

Das Prin­zip SLA spiegelt sich in der Struk­tur der Seiten im Wiki wider. Für jede Seite im Wiki gibt es einen Bau­stein, in dem klar defi­niert ist, was in der Seite beschrie­ben wird und was nicht in diese Seite gehört.

SOC

Das Prin­zip SOC spiegelt sich in der Struk­tur der Seiten im Wiki wider. In den Bau­steinen unter­scheiden Autoren fach­liche von tech­nischen Belangen dort, wo es Sinn macht.

Spec

Der Bau­stein Spec ist ein Ergeb­nis der Pro­dukt­ent­wick­lung und Teil des Archi­tektur­entwurfs einer Pro­dukt­doku­menta­tion. Er beschreibt ein pro­dukt­spezifi­sches Kon­zept für das IT-System.

Spezifi­kation

Eine Spezifi­kation ist eine doku­men­tierte Infor­mation, die im Wiki als Teil der Pro­dukt­doku­menta­tion ver­öffent­licht wird. Die Bear­bei­tung fin­det aber an einer anderen Stelle statt.

SRP

Das Prin­zip SRP regelt die Ver­antwor­tung für den Inhalt im Wiki. Eine Seite im Wiki hat immer genau einen Autor. Er ist für den Inhalt der Seite ver­ant­wort­lich, bis sie “fertig” ist.

Term

Für einen wichtigen Begriff der Anwen­dungs­domäne gibt es ein Ein­trag im Glossar als Seite im Wiki. Der Begriff wird mindestens aus der Sicht des Pro­duk­tes erklärt. Alter­native Defi­nitio­nen zur Abgren­zung sind mög­lich.

Topic

Der Bau­stein Topic ist das Ergeb­nis aus dem Pro­jekt­manage­ment und Teil der System­beschrei­bung einer Pro­dukt­doku­mentation. Er beschreibt einen klar abge­grenzten Auf­gaben­bereich, in dem das IT-System Ver­wendung findet.

Wiki

Das Wiki ist das zen­trale Ver­zeich­nis für doku­men­tierte Infor­matio­nen zu einem Pro­dukt. Es ist als Werk­zeug ein wesent­­licher Bestand­­teil des Gesamt­­kon­zeptes von cards+.

XSD

XSD ist eine vom W3C ver­öffent­lichte Schema­beschrei­bungs­sprache. Die XSD-Datei kann direkt als Spezifi­kation im Wiki ver­öffent­licht werden.