Zum Inhalt springen
EngineerBeratung
Menü
Design
Deutsch

Engineer / Beratung / Portfolio

Dokumentation einem eigenen Linter unterstellt

Die Dokumentation einem eigenen Linter unterstellt — mit nur absenkbarem Zeilenbudget je Datei, Inhaltsverzeichnispflicht und Prüfung echter Pfade — der sechs von neun als erledigt markierte Pläne mit offenen Aufgaben und vierzehn in keinem Dokument genannte verpflichtende Commit‑Prüfungen fand.

Situation. Das Repository steuert sich über schriftliche Anweisungen: sechsundzwanzig Dokumente zu Qualität, Designsystem, Barrierefreiheit, Druck, Metadaten, Übersetzung und Git. Solche Anweisungen verfallen nach einem typischen Muster: Sie werden länger, weichen vom Code ab, verweisen auf verschobene Dateien und werden ab einer bestimmten Größe nicht mehr gelesen. Eine ungelesene Regel ist keine Regel.

Aufgabe. Die Dokumentation brauchte dieselbe Behandlung wie Code: einen Linter mit verbindlich scheiternden Grenzen statt Empfehlungen.

Massnahmen. Acht Richtlinien wurden mechanisch prüfbar. Eine harte Längenobergrenze und eine weichere Warnschwelle. Ein nur absenkbares Zeilenbudget je Datei, damit geschrumpfte Dokumente nicht wieder wachsen. Inhaltsverzeichnisse und bei geringerer Schwelle Abschnittsindizes. Eine Zuständigkeitsregel für Themenorte. Gültige Links. Ehrliche Planstände entsprechend den eigenen Aufgabenlisten. Die Benennung jeder commitblockierenden Aufgabe in mindestens einem Dokument. Und die Existenz jedes verzeichnisqualifizierten Pfads und jedes benannten Codesymbols. Bereits der erste Lauf begründete die ganze Arbeit: sechs als erledigt bezeichnete Pläne mit offenen Kästchen, vierzehn undokumentierte Commit‑Prüfungen, drei tote Links, ein verwaistes Dokument und drei tote Pfade in fünf Dokumenten. Anschließend wies das Budget den eigenen Autor zurück: Die Zusammenfassung dieser Arbeit überschritt die Grenze des Entwicklungsdokuments. Deshalb entstand ein separates Dokument — genau die beabsichtigte Wirkung der Richtlinie.

Ergebnis. Sechsundzwanzig Dokumente mit etwa 2.666 effektiven Zeilen stehen jeweils unter einem nicht erhöhbaren Budget. Alle benannten Pfade und Symbole werden gegen den Dateibaum geprüft. Der unbequeme Kernbefund bleibt: Vierzehn Prüfungen blockierten jeden Commit, standen aber in keinem Dokument. Maschinenregeln und von Menschen gelesene Regeln waren bereits auseinandergefallen.

Kontakt

Sie klären noch, was Sie benötigen?

Erzählen Sie uns, was nicht funktioniert oder was Sie entwickeln möchten. Wir sagen Ihnen, was dafür nötig wäre, was es ungefähr kosten würde und ob wir die Richtigen dafür sind.

Ab 1.400 DKK pro Stunde, zuzüglich Mehrwertsteuer — und weniger pro Stunde bei längerer Buchung.

welcome@engineer.company +45 50 10 61 84 Kopenhagen, Dänemark