Processus de documentation

Ce document décrit comment la documentation jinflow est rédigée, vérifiée, maintenue et synchronisée avec le codebase. Le système de documentation est de l’infrastructure — il a le même statut que les compilateurs, validateurs et suites de tests.

Principes

1. Le code est la source de vérité. La documentation décrit ce que fait le code, pas ce que nous souhaitons qu’il fasse.
2. Chaque affirmation est vérifiable. Les commandes CLI peuvent être vérifiées contre les subparsers de cli.py.
3. Le contenu aspirationnel est étiqueté. Les documents de conception décrivant des fonctionnalités non implémentées portent status: aspirational.
4. Un seul emplacement autoritaire, des copies synchronisées.
5. Conscience de la phase de croissance. Le produit livre des fonctionnalités plus vite que la documentation ne peut suivre.

Le détecteur de drift

scripts/docsdrift.py est une vérification automatisée qui compare le code à la documentation sur quatre dimensions :

Dimension	Source code	Source doc	Comment
Commandes CLI	jinflow/cli.py appels add_parser()	en-têtes ### du cheatsheet	Extraction regex, comparaison d’ensembles
Pages Explorer	fichiers +page.svelte	Table Pages du guide explorer	Parcours filesystem, parsing de table
Types de Signal	VALID_TYPES de probecheck.py	Ligne Types du guide instruments	Extraction regex, comparaison d’ensembles
Frontmatter	n/a	docs architecture/design	Vérification des 200 premiers octets pour status:

python3 scripts/docsdrift.py              # full report
python3 scripts/docsdrift.py --quiet      # only show drift (exit 1 if found)

Pour le processus complet de documentation incluant l’audit, la taxonomie et les flux de synchronisation, voir la version anglaise.