mirror of
https://github.com/MaksTinyWorkshop/_Assistant_Lead_Tech
synced 2026-04-06 21:41:42 +02:00
fe04edb7bf
- Nouveaux fichiers : 10_product_patterns_valides.md, 10_conventions_redaction.md - Templates n8n déplacés vers 70_templates/ (workflow + intégration) - Contenu 10_n8n_README.md absorbé dans les fichiers dédiés patterns/risques - Suppression des stubs 10_n8n_README.md, 20_worklows_README.md, 30_integrations_README.md - Index, _AI_INSTRUCTIONS, 95_a_capitaliser et post-bmad-install.sh mis à jour Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1.5 KiB
1.5 KiB
Conventions de rédaction technique
Ce fichier capitalise les conventions de documentation et rédaction technique validées sur les projets Lead_tech : tone of voice, structure des docs, formats récurrents.
Objectif : produire une documentation cohérente d'un projet à l'autre, réduire le temps de rédaction et de relecture.
Dernière mise à jour : 2026-03-08
Règle d'or
Une convention n'a sa place ici que si elle a été appliquée et validée sur au moins un projet réel. Pas de "bonne pratique" théorique.
Périmètre couvert
- Tone of voice par type de doc (API, user-facing, interne)
- Structure standard des fichiers README, CLAUDE.md, ADR
- Format des changelogs et release notes
- Conventions de nommage (fichiers, titres, sections)
- Règles de maintenance de la documentation (quand mettre à jour, quoi archiver)
Format standard d'une convention
Convention :
- Scope : (type de document concerné)
- Règle : …
- Exemple : …
- Contre-exemple : …
- Validé le : DD-MM-YYYY
- Contexte projet : …
Conventions actives
Convention : Langue par type de document
- Scope : tous les fichiers du repo Lead_tech et des projets
- Règle : français pour toute la documentation, commentaires de code, messages de commit. Anglais pour les identifiants de code (variables, fonctions, types).
- Validé le : 2026-03-08
- Contexte projet : Lead_tech (convention globale)
Index
(à remplir au fil des validations)