Une bonne documentation garantit que la CLI, l API et les artefacts de release mgpy racontent la meme histoire. Une documentation manquante augmente les couts de support et d integration.
Points cles
- CLI: Sous Windows, les exemples utilisent la forme recommandee
py -3.12 -m <module> ...(par ex.py -3.12 -m manifestguard ...). Sous Linux/macOS, cela correspond generalement apython3.12 -m .... - README, guide d installation et docstrings doivent decrire le meme chemin d entree.
- Les API publiques doivent documenter valeurs de retour, cas d erreur et exemples d appel.
- La documentation doit faire partie du pipeline de release, pas d une phase de rattrapage apres merge.
Workflow mgpy recommande
- Documenter d abord les chemins CLI et API publics que les utilisateurs voient reellement.
- Ajouter ensuite les details d implementation, ADR et workflows speciaux.
- Avant une release, verifier que README, INSTALLATION et exemples CI montrent encore les memes commandes.
Demarrage rapide
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