3.0 KiB
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
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
└── 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 actifs de planification
La clôture de la phase fondatrice est suivie dans plans/001-V0_0_3_PLAN.md. La séquence des premières releases fonctionnelles est définie dans plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md.
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/.
Leur contrat de rédaction, de dimensionnement et de cycle de vie est défini dans rules/PROMPT_STRUCTURE.md.
Documents normatifs
Les règles sont indexées depuis ../RULES.md. Aucun document de brainstorming, plan ou delta ne devient normatif uniquement parce qu'il existe dans le dépôt.