Der Audit erkennt Link-, Owner-, Staleness-, Coverage-, Changelog- und Deprecation-Lücken in Docs-Repos datei- und zeilengenau.
Produkt documentation-audit · Version 0.1.0
Documentation Quality Audit (synthetic docs repo, technical draft)
Standardisierter, deterministischer Audit für Dokumentations-Repos. Prüft ein synthetisches Paket (docs-policy.yaml, doc-index.csv, docs-Seiten) auf fehlende Owner/Status/Review-Daten/Titel/Pfade/Kategorien, veraltete Reviews, kaputte Links, zu kurze Seiten, Duplikate, fehlende Pflichtabschnitte, TODO-Platzhalter und Orphan-Seiten. Liefert datei-/zeilengenaue Befunde und transparenten Documentation-Quality-Score; evidenzgebunden und reproduzierbar. Kein Netz/LLM/Crawl; technischer Entwurf, keine Rechts-/Compliance- Dokumentationsgarantie.
Zielkunde (ICP)
Engineering-/Docs-Teams in mittelständischen Unternehmen, die Dokumentations-Repos vor Releases oder Audits auf Vollständigkeit, Aktualität und Linkqualität prüfen müssen.
Problem
Veraltete, unvollständige oder verwaiste Dokumentation und kaputte Links erzeugen Support- und Compliance-Risiken. Manuelle Reviews sind inkonsistent; Teams benötigen eine deterministische, lokal laufende Prüfung mit datei-/ zeilengenauen Fix-Aufträgen.
Liefermodelle
- Audit as a Service
- Agent as a Service
Service-Level (SLA)
| Feld | Wert |
|---|---|
delivery_time_hours | 48 |
max_findings_per_audit | 200 |
max_runtime_seconds | 120 |
Grenzen des Produkts
- Rein statischer Audit eines synthetischen Docs-Repos; kein Wiki-/Web- Crawl, kein Netz/LLM.
- Technischer Entwurf; keine Rechts-/Compliance-Dokumentationsgarantie.
- Heuristiken über deklarierte Felder; alle Inhalte sind fiktiv.
- Documentation-Quality-Score ist ein technisches Signal, keine Garantie.
- Rein statischer Audit eines synthetischen Docs-Repos; kein Wiki-/Web- Crawl, kein Netz/LLM.
- Technischer Entwurf; keine Rechts-/Compliance-Dokumentationsgarantie.
- Heuristiken über deklarierte Felder; alle Inhalte sind fiktiv.
Verträge: Eingabe und Ausgabe
Ein Claim erscheint nur, wenn die Evidenz zur exakten Version passt. Contract-Felder werden aus dem veröffentlichten Datenvertrag gerendert.
JSON-Schema (input_contract) aus dem veröffentlichten Datenvertrag. Der Runner validiert Ein- und Ausgaben gegen dieses Schema.
{
"properties": {
"repository_snapshot": {
"type": "object"
}
},
"required": [
"repository_snapshot"
],
"type": "object"
}| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
repository_snapshot | object | ja |
JSON-Schema (output_contract) aus dem veröffentlichten Datenvertrag. Der Runner validiert Ein- und Ausgaben gegen dieses Schema.
{
"properties": {
"findings": {
"type": "object"
},
"report": {
"type": "object"
}
},
"required": [
"report",
"findings"
],
"type": "object"
}| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
findings | object | ja | |
report | object | ja |
Veröffentlichte Claims (gate-geprüft)
Jeder folgende Claim ist an mindestens einen PASSED-Evidenz-Record gebunden. Die SHA-256-Hashwerte der Records sind direkt an jedem Claim sichtbar; nicht freigegebene Claims werden nicht gerendert.
Jeder Audit-Lauf ist deterministisch, unabhängig re-validiert und über einen hash-verketteten Evidence-Record mit Ed25519-Signaturen und Contract-Digests reproduzierbar.
Jeder Befund ist datei- und zeilengenau mit Evidenz/Fix-Anweisung dokumentiert; der Documentation-Quality-Score ist transparent.
Es sind keine unterdrückten Claims für dieses Produkt im Gatekeeper-Status enthalten.
Workflow
Ausführungsschritte laut Manifest; jeder Schritt referenziert einen geprüften Skill.
| Schritt | Skill | Beschreibung | Abhängig von |
|---|---|---|---|
audit | documentation_audit | Docs-Repo statisch prüfen. | — |
Skills in diesem Produkt
Versionen, Schwellenwerte und Evidenzstand je Skill. Details in der Skill-Registry.
| Skill | Version | Reife | Recall / Precision | Evidenz | Letzte Evidenz |
|---|---|---|---|---|---|
| Documentation Quality Audit (synthetic docs repo, technical draft) | 0.1.0 | VALIDATED | 1,000 / 0,900 | 1 | b430eb4342c54e358e42c02b48eda4c7 |
Evidenz für dieses Produkt
Ausschließlich verifizierte Records. Hashes und Artefaktpfade sind im Evidenz-Detail einsehbar.
record_sha256: 258f61ebe48c8f82bcf17e23a6eafbf4bba9687a259588a966d1da42524b565b
- Rein statischer Audit eines synthetischen Docs-Repos; kein Wiki-/Web- Crawl, kein Netz/LLM.
- Technischer Entwurf; keine Rechts-/Compliance-Dokumentationsgarantie.
- Heuristiken über deklarierte Felder; alle Inhalte sind fiktiv.
- … 4 weitere
Bericht: evidence/artifacts/b430eb4342c54e358e42c02b48eda4c7/report.md
Weitere Dokumentation
Kein Dokumentationspfad veröffentlicht.