31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
# README — 4NK_template
|
||
|
||
## Présentation
|
||
Template documentaire, CI et scripts de qualité/sécurité pour initier des projets 4NK cohérents et industrialisés.
|
||
|
||
## Objectifs
|
||
- Offrir des modèles de documentation prêts à l’emploi
|
||
- Standardiser qualité, tests, sécurité et release
|
||
- Faciliter l’exécution d’agents de conformité
|
||
|
||
## Périmètre
|
||
- Documentation générique (non applicative)
|
||
- CI Gitea (tests, security-audit, release-guard, bash-required)
|
||
- Scripts d’agents (bash recommandé, fallback PowerShell)
|
||
|
||
## Structure
|
||
- `docs/project/**` — Documentation du template
|
||
- `docs/templates/**` — Modèles à copier dans les projets
|
||
- `scripts/agents/**` — Agents et outillage
|
||
- `tests/**` — Structure, journaux et rapports
|
||
|
||
## Utilisation
|
||
- Lire `docs/project/INDEX.md`
|
||
- Consulter `docs/project/USAGE.md` pour l’usage détaillé
|
||
- Exécuter les agents pour un diagnostic: rapport dans `tests/reports/agents`
|
||
|
||
## Gouvernance
|
||
- Standards: `docs/QUALITY_STANDARDS.md`
|
||
- Open source: `docs/OPEN_SOURCE_GUIDE.md`
|
||
- Publication: `docs/project/RELEASE_PLAN.md`
|