Gute Dokumentation sorgt bei mgpy dafuer, dass CLI, API und Release-Artefakte dieselbe Geschichte erzaehlen. Fehlende Doku erzeugt Support- und Integrationskosten.
Kernpunkte
- CLI: Unter Windows zeigen die Beispiele den empfohlenen Aufruf via
py -3.12 -m <modul> ...(z.B.py -3.12 -m manifestguard ...). Auf Linux/macOS entspricht das in der Regelpython3.12 -m .... - README, Installationsguide und Docstrings muessen denselben Einstiegspfad beschreiben.
- Oeffentliche APIs sollten Rueckgabewerte, Fehlerfaelle und Beispielaufrufe dokumentieren.
- Dokumentation gehoert in die Release-Pipeline, nicht erst in Nacharbeiten nach dem Merge.
Empfohlener MG-Python-Workflow
- Zuerst die oeffentlichen CLI- und API-Pfade dokumentieren, die externe Nutzer wirklich sehen.
- Danach Implementierungsdetails, ADRs und Spezialworkflows ergaenzen.
- Vor einem Release pruefen, ob README, INSTALLATION und CI-Beispiele noch dieselben Befehle zeigen.
Schnellstart
py -3.12 -m manifestguard check --extended
py -3.12 -m manifestguard schema --output openapi.json
py -3.12 run_manifestguard.py --report .manifestguard/manifestguard-report.json