refonte documentaire
This commit is contained in:
parent
7b13d6382f
commit
fcee1ea9b1
20 changed files with 138 additions and 0 deletions
83
docs/README.md
Normal file
83
docs/README.md
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
# 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**.
|
||||
7
docs/archive/README.md
Normal file
7
docs/archive/README.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Archive documentaire
|
||||
|
||||
Ce répertoire contient des documents conservés pour mémoire historique.
|
||||
|
||||
Ils peuvent être utiles pour retracer l’évolution du projet, mais ils ne doivent plus être utilisés comme références actives.
|
||||
|
||||
Pour les documents canoniques, revenir à `docs/README.md`.
|
||||
|
|
@ -1,3 +1,11 @@
|
|||
# STATUT : ARCHIVÉ
|
||||
|
||||
Ce document n’est plus une référence active. Version courte remplacée par `docs/architecture/architecture-life-noc.md`.
|
||||
|
||||
Ne pas l’utiliser comme source canonique.
|
||||
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
## Vue d'ensemble
|
||||
|
|
@ -1,3 +1,11 @@
|
|||
# STATUT : ARCHIVÉ
|
||||
|
||||
Ce document n’est plus une référence active. Version courte remplacée par `docs/vision/vision-fondatrice.md` et `docs/architecture/architecture-life-noc.md`.
|
||||
|
||||
Ne pas l’utiliser comme source canonique.
|
||||
|
||||
---
|
||||
|
||||
# Concept Life-NOC
|
||||
|
||||
Life-NOC transpose la logique d'un NOC à la vie réelle.
|
||||
|
|
@ -1,3 +1,11 @@
|
|||
# STATUT : ARCHIVÉ
|
||||
|
||||
Ce document n’est plus une référence active. Document fusionné puis remplacé par `docs/modeles/probe-model-v1.md` et `docs/modeles/inputs-store-model-v1.md`.
|
||||
|
||||
Ne pas l’utiliser comme source canonique.
|
||||
|
||||
---
|
||||
|
||||
# Life-NOC — Modèle des sondes et des intrants v1
|
||||
|
||||
## 1. Objet
|
||||
|
|
@ -1,3 +1,11 @@
|
|||
# STATUT : ARCHIVÉ
|
||||
|
||||
Ce document n’est plus une référence active. Compilation redondante remplacée par l’index structuré `docs/README.md` et les documents canoniques par thème.
|
||||
|
||||
Ne pas l’utiliser comme source canonique.
|
||||
|
||||
---
|
||||
|
||||
# Life-NOC — Documentation complète
|
||||
|
||||
## 1. Présentation générale
|
||||
|
|
@ -1,3 +1,11 @@
|
|||
# STATUT : ARCHIVÉ
|
||||
|
||||
Ce document n’est plus une référence active. Doublon exact de `docs/vision/vision-fondatrice.md`.
|
||||
|
||||
Ne pas l’utiliser comme source canonique.
|
||||
|
||||
---
|
||||
|
||||
# Vision fondatrice — Life-NOC
|
||||
|
||||
## Définition
|
||||
8
docs/archive/rituel_matinal.md
Normal file
8
docs/archive/rituel_matinal.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
# STATUT : ARCHIVÉ
|
||||
|
||||
Ce document n’est plus une référence active. Fichier vide conservé uniquement à titre historique.
|
||||
|
||||
Ne pas l’utiliser comme source canonique.
|
||||
|
||||
---
|
||||
|
||||
Loading…
Reference in a new issue