docs: rédiger README.md et scripts/README.md
📋 User Story
En tant que nouveau contributeur ou équipe forkant shared-guidelines\
Je veux trouver une documentation d'ensemble du repo et du script d'installation\
Afin de comprendre l'architecture, l'usage et le fonctionnement sans devoir lire tout le code source\
Contexte
Le repo shared-guidelines est un framework forkable de guidelines partagées (technos, agents, steps, docs) installé via scripts/install-guidelines.js dans les projets consommateurs, selon le pattern submodule (lib/guidelines/) décrit dans les commentaires du script :
/**
* Shared Guidelines Installation Script
*
* Automates installation and synchronization of shared-guidelines using git submodules.
* See scripts/README.md for full documentation.
* ...
*/
Ce commentaire référence explicitement scripts/README.md comme documentation complète du script.
Problème
-
README.mdà la racine contient une seule ligne (# shared/guidelines) — aucune explication du but du repo, de son architecture (guidelines/technos/,guidelines/agents/,guidelines/docs/,guidelines/categories.json), ni de comment l'utiliser. -
scripts/README.md, référencé dans le commentaire d'en-tête deinstall-guidelines.js, n'existe pas dans le repo. La documentation "complète" promise pour le script d'installation est introuvable.
Conséquence : un nouveau contributeur ou une équipe qui souhaite forker ce repo pour son propre usage n'a aucun point d'entrée pour comprendre comment fonctionne le système (registre techs.yaml, résolution de versions, flags --techs/--arch/--claude/--cursor/--copilot, structure guidelines/agents/shared vs specific, steps {{step: name}}, génération multi-outils) sans lire l'intégralité du script de 2200+ lignes.
Objectifs
-
README.md: vue d'ensemble du repo — objectif du projet, pattern submodule, structure des dossiers (guidelines/technos,guidelines/agents,guidelines/docs,guidelines/steps,guidelines/categories.json), lien versscripts/README.mdpour le détail de l'installation, lien vers.gitlab-ci.yml/check-structure.jspour la validation. -
scripts/README.md: documentation technique du script d'installation — commande d'usage (npm run guidelines:install), flags disponibles (--techs,--arch,--claude/--cursor/--copilot), format detechs.yaml(base/versions/versionFiles/latest), mécanisme de résolution des steps ({{step: name}}), sorties générées par outil cible (Claude agents/skills, Cursor rules, Copilot instructions, Agent Skills spec), comportement de migration des entry points existants (CLAUDE.md,.cursorrules, etc.).
Critères d'acceptation
- Étant donné un nouveau contributeur clonant le repo, quand il lit
README.md, alors il comprend le but du repo et sait où chercher pour aller plus loin (renvoi versscripts/README.md). - Étant donné un développeur voulant utiliser
install-guidelines.js, quand il litscripts/README.md, alors il connaît tous les flags disponibles, le format detechs.yaml, et n'a pas besoin de lire le code source du script pour une utilisation standard. - Étant donné le commentaire d'en-tête de
install-guidelines.jsréférençantscripts/README.md, quand ce fichier est créé, alors la référence n'est plus un lien mort.
Dépendances
Aucune. Rédaction pure, pas de changement de code.
Notes techniques
Base de rédaction : lire intégralement scripts/install-guidelines.js (13 étapes d'installation, step1_CopyDocsShared à la fin du pipeline) pour documenter fidèlement le comportement réel plutôt que de deviner.