Audit-Vorlage
documentation
Prüft deine Doku gegen den Standard und gegen den Code, der sie bestätigt oder widerlegt.
Mappt auf: DOCUMENTATION-STANDARD · DiátaxisEin Doku-Framework, das Inhalte in Tutorials, How-tos, Referenz und Erklärung aufteilt.
Spezialisten, parallel
Jeder Befund ist belegbasiert und übersteht ≥2-von-3 adversarielle Skeptiker.
Wie dieses Audit arbeitet
Spezialisten-Agents gehen jede kritische Leser-Journey nur mit der Doku durch und verifizieren dann jede Aussage gegen die Realität: dokumentierte Commands laufen gegen die Scripts, Env-Variablen werden gegen den lesenden Code geprüft, Code-Beispiele werden nachvollzogen oder ausgeführt. Bewertet werden Repo-Kopf, Onboarding, Doc-Code-DriftDie Abweichung zwischen dem, was die Doku sagt, und dem, was der Code tatsächlich tut., Schreibstil und DiátaxisEin Doku-Framework, das Inhalte in Tutorials, How-tos, Referenz und Erklärung aufteilt.-Passung auf einer 0-100-Rubrik — jede Seite gemessen an dem Job, den sie erfüllen soll.
Wann du es einsetzt
Vor dem Open-Sourcing
Du machst ein Repo öffentlich, und das README ist die Eingangstür. Das Audit geht Clone bis erster grüner Test als neuer Leser durch, nennt den genauen Schritt, an dem er hängenbleibt, und markiert fehlende Value-Line, Badge-Reihe, Management-Summary und Architektur-Diagramm.
Nach einem Refactor mit Umbenennungen
Ein Refactor hat Scripts, Env-Variablen und Modulpfade umbenannt, die Doku beschreibt aber noch die alten Namen. Das Audit testet dokumentierte Commands gegen die package.json, Env-Variablen gegen den lesenden Code und .env.example gegen die Realität — und liefert ein Drift-Register, das für jeden Treffer Doku- und Code-Zeile zitiert.
Übergabe eines Service an On-Call
Du gibst einem anderen Team den Pager für einen Service, den es nicht gebaut hat. Das Audit prüft RunbooksEine dokumentierte Schritt-für-Schritt-Anleitung, um ein System zu betreiben oder einen bestimmten Vorfall zu bearbeiten., Rollback-Schritte und Referenz-Doku gegen die echte Infra und API-Oberfläche, sodass ein falscher Rollback-Schritt oder eine undokumentierte Pflicht-Config als P0/P1 auftaucht, bevor es um 3 Uhr nachts der Alarm tut.
Was du bekommst
Eine Rubrik-Scorecard mit Notenband plus ein Drift-Register und priorisierte deutsche GitHub-Issues, jedes mit einem Vorher/Nachher-Fix.