77 lines
5.4 KiB
Markdown
77 lines
5.4 KiB
Markdown
<!-- file: docs/000-README.md -->
|
||
<!-- version: 22 -->
|
||
|
||
# Documentation KSP
|
||
|
||
Ce fichier est le point d'entrée du répertoire `docs/`.
|
||
|
||
Le préfixe `000-` est volontaire : la documentation est destinée à devenir volumineuse et cette convention maintient le point d'entrée en première position dans les listings, arbres de fichiers et classements lexicaux usuels. Dans les répertoires documentaires où un ordre explicite est utile, d'autres fichiers prioritaires peuvent utiliser `001-`, `002-`, etc. ; `000-README.md` reste toujours prioritaire. Cette convention ne s'applique pas aux fichiers situés à la racine du dépôt.
|
||
|
||
## Rôle de `docs/`
|
||
|
||
Le répertoire contient la documentation durable du projet : règles détaillées, idées à explorer, architecture, références, décisions, guides, plans et validations.
|
||
|
||
Les documents temporaires d'une livraison ne sont pas stockés sous `docs/`. Ils sont enregistrés sous `deltas/` afin de conserver un seul historique de livraison pour l'ensemble du dépôt.
|
||
|
||
## Organisation
|
||
|
||
```text
|
||
docs/
|
||
├── 000-README.md
|
||
├── IDEAS.md
|
||
├── architecture/
|
||
│ ├── 000-README.md
|
||
│ ├── 001-PROJECT_OBJECTIVES.md
|
||
│ ├── 002-LAYERS_AND_DEPENDENCIES.md
|
||
│ ├── 003-COMPONENT_CONTRACTS.md
|
||
│ ├── 004-COMPONENT_INVENTORY.md
|
||
│ ├── 005-DEPENDENCY_GRAPH.md
|
||
│ ├── 006-WIRE_AND_PROGRAM.md
|
||
│ ├── 007-EXECUTION_AND_POLICY.md
|
||
│ ├── 008-DATA_MATERIALIZATION_AND_STORE.md
|
||
│ ├── 009-ACQUISITION_WORKERS_AND_JOBS.md
|
||
│ └── 010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md
|
||
├── plans/
|
||
│ ├── 000-README.md
|
||
│ ├── 001-V0_0_3_PLAN.md
|
||
│ ├── 002-FUNCTIONAL_RELEASE_SEQUENCE.md
|
||
│ ├── 003-V0_1_1_CORE_FOUNDATION_PLAN.md
|
||
│ ├── 004-V0_1_2_LOGGING_FOUNDATION_PLAN.md
|
||
│ ├── 005-V0_1_3_CONFIG_FOUNDATION_PLAN.md
|
||
│ ├── 006-V0_1_4_CONFIG_DESKTOP_PLAN.md
|
||
│ ├── 007-V0_2_0_SERIES_PLANNING.md
|
||
│ └── 008-V0_2_1_ONCHAIN_HTTP_PLAN.md
|
||
├── validation/
|
||
│ ├── 000-README.md
|
||
│ ├── 001-V0_1_4_CONFIG_DESKTOP.md
|
||
│ └── 002-V0_2_0_SERIES_PLANNING.md
|
||
└── rules/
|
||
├── FILE_CONTRACTS.md
|
||
├── PROMPT_STRUCTURE.md
|
||
├── RULES_DEPENDENCIES.md
|
||
├── RULES_DOCUMENTATION.md
|
||
├── RULES_GENERAL.md
|
||
├── RULES_KSP.md
|
||
├── RULES_RUST.md
|
||
├── SCENARIO_CONVENTION.md
|
||
└── VERSION_WORKFLOW.md
|
||
```
|
||
|
||
D'autres sous-répertoires seront ajoutés uniquement lorsque leur rôle aura été décidé, notamment pour les références, décisions, guides et validations.
|
||
|
||
## Documents de planification
|
||
|
||
Le plan historique de la phase fondatrice clôturée est conservé dans [`plans/001-V0_0_3_PLAN.md`](plans/001-V0_0_3_PLAN.md). La séquence active des premières releases fonctionnelles est définie dans [`plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md`](plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md). Le plan détaillé de la release stable `0.1.1` est conservé comme historique clôturé dans [`plans/003-V0_1_1_CORE_FOUNDATION_PLAN.md`](plans/003-V0_1_1_CORE_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.2` est conservé comme historique clôturé dans [`plans/004-V0_1_2_LOGGING_FOUNDATION_PLAN.md`](plans/004-V0_1_2_LOGGING_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.3 — Configuration foundation` est conservé comme historique clôturé dans [`plans/005-V0_1_3_CONFIG_FOUNDATION_PLAN.md`](plans/005-V0_1_3_CONFIG_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.4 — ksp-app-config-desk` est conservé comme historique clôturé dans [`plans/006-V0_1_4_CONFIG_DESKTOP_PLAN.md`](plans/006-V0_1_4_CONFIG_DESKTOP_PLAN.md), avec sa matrice finale [`validation/001-V0_1_4_CONFIG_DESKTOP.md`](validation/001-V0_1_4_CONFIG_DESKTOP.md). Son prompt d'ouverture historique reste [`../prompts/004-V0_1_4_START_PROMPT.md`](../prompts/004-V0_1_4_START_PROMPT.md). La release stable `0.2.0` clôt l'audit de bot3 et le découpage de la série. Son plan directeur est conservé comme historique clôturé dans [`plans/007-V0_2_0_SERIES_PLANNING.md`](plans/007-V0_2_0_SERIES_PLANNING.md), avec sa matrice finale [`validation/002-V0_2_0_SERIES_PLANNING.md`](validation/002-V0_2_0_SERIES_PLANNING.md). `0.2.1` a été ouverte par [`../prompts/006-V0_2_1_START_PROMPT.md`](../prompts/006-V0_2_1_START_PROMPT.md). Son `pre.001` applique le gate de sizing, crée le plan actif [`plans/008-V0_2_1_ONCHAIN_HTTP_PLAN.md`](plans/008-V0_2_1_ONCHAIN_HTTP_PLAN.md) et produit d'abord un split HTTP sur `0.2.1`–`0.2.6`. `0.2.1-pre.001-fix.001` recalibre ensuite ce split sur `0.2.1`–`0.2.4` sans perdre l'inventaire exhaustif, et précise que plusieurs releases peuvent être enchaînées dans un même chat si chacune est clôturée séparément et si le sizing de la suivante reste positif.
|
||
|
||
`IDEAS.md` conserve les pistes et questions qui ne sont pas encore des engagements du roadmap ni des décisions architecturales.
|
||
|
||
## Prompts
|
||
|
||
Les prompts de reprise eux-mêmes sont conservés sous [`../prompts/`](../prompts/).
|
||
|
||
Leur contrat de rédaction, de dimensionnement et de cycle de vie est défini dans [`rules/PROMPT_STRUCTURE.md`](rules/PROMPT_STRUCTURE.md).
|
||
|
||
## Documents normatifs
|
||
|
||
Les règles sont indexées depuis [`../RULES.md`](../RULES.md). Aucun document de brainstorming, plan ou delta ne devient normatif uniquement parce qu'il existe dans le dépôt.
|