84 lines
2.7 KiB
Markdown
84 lines
2.7 KiB
Markdown
|
# Documentation Life-NOC
|
|||
|
|
|
|||
|
|
Cette arborescence constitue le **point d’entrée documentaire** du dépôt.
|
|||
|
|
|
|||
|
|
## Règles de lecture
|
|||
|
|
|
|||
|
|
- **Un sujet = un document canonique**
|
|||
|
|
- les documents sous `docs/archive/` sont **historiques** et **non normatifs**
|
|||
|
|
- `domains.yaml` demeure la **source de vérité opérationnelle** du système
|
|||
|
|
- la documentation explique, cadre et guide ; elle ne remplace pas la configuration active
|
|||
|
|
|
|||
|
|
## Structure
|
|||
|
|
|
|||
|
|
### `docs/vision/`
|
|||
|
|
Cadre conceptuel et formulations de référence.
|
|||
|
|
|
|||
|
|
- `vision/vision-fondatrice.md` — définition, finalité et nature de Life-NOC
|
|||
|
|
- `vision/devise-et-formulations.md` — devise, formulations de positionnement et langage de référence
|
|||
|
|
|
|||
|
|
### `docs/architecture/`
|
|||
|
|
Choix structurants et fonctionnement d’ensemble.
|
|||
|
|
|
|||
|
|
- `architecture/architecture-life-noc.md` — architecture complète et articulation des composants
|
|||
|
|
- `architecture/decisions-techniques.md` — décisions de principe et choix techniques retenus
|
|||
|
|
|
|||
|
|
### `docs/modeles/`
|
|||
|
|
Modèles canoniques utilisés par le système.
|
|||
|
|
|
|||
|
|
- `modeles/probe-model-v1.md` — modèle canonique des sondes
|
|||
|
|
- `modeles/inputs-store-model-v1.md` — modèle de stockage des intrants vivants
|
|||
|
|
|
|||
|
|
### `docs/guides/`
|
|||
|
|
Guides pratiques pour installer, exploiter et utiliser Life-NOC.
|
|||
|
|
|
|||
|
|
- `guides/deploiement-from-scratch.md` — déploiement depuis Debian 12 vanille
|
|||
|
|
- `guides/exploitation-life-noc.md` — exploitation, vérifications et dépannage
|
|||
|
|
- `guides/guide-usager-life-noc.md` — usage courant côté utilisateur
|
|||
|
|
|
|||
|
|
### `docs/roadmap/`
|
|||
|
|
Évolution planifiée du système.
|
|||
|
|
|
|||
|
|
- `roadmap/plan-demockage-life-noc.md` — trajectoire de démockage et de pages item canoniques
|
|||
|
|
|
|||
|
|
### `docs/validation/`
|
|||
|
|
Constats validés sur le terrain.
|
|||
|
|
|
|||
|
|
- `validation/preuve-de-reproductibilite.md` — résultats réellement reproduits
|
|||
|
|
|
|||
|
|
### `docs/archive/`
|
|||
|
|
Documents anciens, fusionnés ou remplacés.
|
|||
|
|
|
|||
|
|
Ne pas les utiliser comme références actives.
|
|||
|
|
|
|||
|
|
## Ordre de lecture conseillé
|
|||
|
|
|
|||
|
|
### Pour comprendre rapidement le projet
|
|||
|
|
|
|||
|
|
1. `vision/vision-fondatrice.md`
|
|||
|
|
2. `architecture/architecture-life-noc.md`
|
|||
|
|
3. `architecture/decisions-techniques.md`
|
|||
|
|
4. `modeles/probe-model-v1.md`
|
|||
|
|
|
|||
|
|
### Pour déployer
|
|||
|
|
|
|||
|
|
1. `guides/deploiement-from-scratch.md`
|
|||
|
|
2. `validation/preuve-de-reproductibilite.md`
|
|||
|
|
3. `guides/exploitation-life-noc.md`
|
|||
|
|
|
|||
|
|
### Pour faire évoluer le système
|
|||
|
|
|
|||
|
|
1. `modeles/probe-model-v1.md`
|
|||
|
|
2. `modeles/inputs-store-model-v1.md`
|
|||
|
|
3. `roadmap/plan-demockage-life-noc.md`
|
|||
|
|
|
|||
|
|
## Politique documentaire
|
|||
|
|
|
|||
|
|
Lorsqu’un document devient redondant, trop partiel ou remplacé par une version canonique plus complète :
|
|||
|
|
|
|||
|
|
- il quitte l’arborescence active
|
|||
|
|
- il passe dans `docs/archive/`
|
|||
|
|
- un statut explicite d’archivage lui est ajouté
|
|||
|
|
|
|||
|
|
L’objectif est de garder une documentation **lisible, non contradictoire et sans doublons actifs**.
|