SEITEN
Was der Auftritt kann
Welche Seite wofür da ist, welche Vorlagen sie benutzt, welche Adressparameter sie versteht – die Fragen, die ein Nachfolger als Erstes stellt.
Studio · Dokumentation
Dokumentation macht man am Ende. Deshalb gibt es keine.
Entwickler hassen sie, die IT verlangt sie, und der Konzern braucht sie für die Revision. Das Ergebnis ist überall dasselbe: Sie entsteht nie – oder sie entsteht einmal, zum Projektabschluss, und veraltet ab Tag zwei. Hier schreiben die Assistenten mit, während sie bauen. Nicht aus Ordnungsliebe, sondern weil das der einzige Zeitpunkt ist, an dem überhaupt noch jemand die Gründe kennt.
01 — Was entsteht
Ein Nachschlagewerk. Keine Nacherzählung.
Der Unterschied ist der ganze Wert. Eine Nacherzählung sagt: „Am 3. September wurde die Kundenakte gebaut." Ein Nachschlagewerk sagt, wofür diese Entität da ist, was ihre Felder bedeuten, warum das Modell so geschnitten ist – und was bewusst weggelassen wurde. Das erste liest niemand zweimal, das zweite spart dem Nächsten einen halben Tag.
- Je fachlichem Bereich ein Dokument, nicht je Sitzung ein Protokoll
- Entscheidungen mit Begründung: warum so und nicht anders
- Offengebliebenes wird als Aufgabe festgehalten, statt im Fließtext zu versacken
- Markdown, versioniert, durchsuchbar – und im Gespräch änderbar wie alles andere
02 — Der Nachfolger
Jedes System hat eine Person, die es versteht. Das ist keine Architektur, das ist ein Risiko.
Ohne Dokumentation
Der Kollege, der es gebaut hat, ist seit zwei Wochen woanders. Was übrig ist: Quelltext ohne Kommentare, ein Feld namens status2, das offenbar wichtig ist, und eine Tabelle, in der drei Spalten dasselbe zu bedeuten scheinen. Der Nachfolger baut lieber neu, als das zu verstehen – und das ist meistens die richtige Entscheidung, wenn auch die teuerste.
Mit mitgeschriebener Dokumentation
Derselbe Fall, nur steht neben dem Bereich ein Dokument: wofür jede Entität da ist, warum der Schnitt so gewählt wurde, was verworfen wurde und weshalb, was offen blieb. Der Nachfolger liest zwanzig Minuten und arbeitet weiter. Es ist nicht spektakulär. Es ist der Unterschied zwischen Fortsetzen und Neuanfangen.
03 — Worüber
Über alles, was der Assistent anfasst.
DATENMODELL
Warum das Modell so aussieht
Entitäten, ihre Felder und ihre Verweise – mit dem Grund für den Schnitt. Genau das, was in einem Diagramm nie steht.
PLUGINS
Was der Code tut
Endpunkte, Batchjobs, HtmlItems und was sie annehmen und zurückgeben. Und die Fallen, über die schon jemand gestolpert ist – damit es nicht zweimal derselbe ist.
SKILLS
Welche Regel wo gilt
Welcher Skill an welchem Auftritt hängt und mit welchen Werten. Damit „wir machen das immer so" endlich nachlesbar ist.
04 — Für die Revision
Der unangenehme Teil, für den es sich rechnet.
In einem Konzern ist Dokumentation keine Tugend, sondern eine Anforderung. Sie wird geprüft, und wer sie nicht hat, erklärt das in einem Termin, den niemand will. Der Wert liegt hier nicht darin, dass jemand sie liest – sondern darin, dass sie existiert, aktuell ist und zeigt, wer wann was entschieden hat.
- Sie entsteht am Feature, das transportiert wurde – also am selben Objekt, das die Änderung ist
- Mit Stand: wann zuletzt geschrieben, und ob seitdem etwas dazugekommen ist
- Neben der Prüfliste des Transports: was geändert wurde, was geprüft wurde, mit welchem Befund
- Gebucht wird das Mitschreiben durch die Assistenten: 49 € im Monat. Die Dokumentation selbst anlegen und pflegen kann jeder
05 — Was fehlt
Was die Dokumentation nicht leistet.
Kein Ersatz für ein Konzept
Sie beschreibt, was gebaut wurde. Was gebaut werden soll, steht davor – und dafür gibt es die Projektplanung.
Kein Prüfsiegel
Dass ein Dokument existiert, heißt nicht, dass die Sache richtig gebaut wurde. Es heißt nur, dass jemand nachlesen kann, wie sie gebaut wurde. Das ist weniger, als Werkzeuge sonst versprechen, und mehr, als sie liefern.
Nur so gut wie das, was der Assistent gesehen hat
Was ein Mensch von Hand direkt in der Datenbank ändert, taucht dort nicht auf. Wer außen herum arbeitet, dokumentiert selbst. Das ist keine Lücke, das ist die Grenze des Werkzeugs.
Weiter im Studio
Und läuft das alles auch?
Erreichbarkeit, Ladezeiten, Tokenverbrauch und Antwortzeiten – gemessen, nicht behauptet.