Spec-Gatekeeper : Workflow de développement piloté par spécifications
Utilisez cette compétence chaque fois qu'une écriture de code source est bloquée par spec-gatekeeper, ou lorsque vous démarrez une nouvelle fonctionnalité, un nouveau service ou une refonte majeure.
Le développement piloté par spécifications (SDD) assure la clarté et élimine les dérives en exigeant un contrat architectural structuré et approuvé avant l'implémentation.
Étapes du workflow
Étape 1 : Mener l'entretien développeur en 4 questions
Avant d'écrire du code ou de créer des fichiers, posez au développeur les 4 questions ciblées suivantes (ou extrayez les réponses des exigences existantes et demandez confirmation) :
-
Portée & Sécurité :
- Quels sont les objectifs principaux et les non-objectifs explicites de cette tâche ?
- Quels composants architecturaux ou limites système sont impliqués ?
- Quelles sont les contraintes de sécurité, permissions, authentification ou sandbox ?
-
Contrats de données :
- Quels sont les schémas exacts, les interfaces API, les types et les formats de protocole ?
- Quels sont les paramètres d'entrée précis et les charges utiles de sortie attendues ?
-
Cas limites & Résilience :
- Quels sont les principaux modes de défaillance, interruptions réseau/E-S et entrées malformées ?
- Quels mécanismes de gestion d'erreur, validation et repli doivent être en place ?
-
Critères d'acceptation :
- Quelle matrice de vérification déterministe et quels cas de test définissent la complétude ?
- Comment chaque critère d'acceptation sera-t-il validé ?
Étape 2 : Rédiger SPEC.md
Créez ou mettez à jour SPEC.md à la racine résolue du projet (<repo_root>/SPEC.md).
Structure requise
Le fichier de spécification doit satisfaire :
- Exigence de taille : Au moins 300 octets UTF-8 de contenu substantiel.
- Titres de sections canoniques : Des titres Markdown de niveau 1 à 3 en dehors des blocs de code correspondant à chacune des 4 sections requises :
- Portée & Sécurité : Titres contenant
Scope,Security,Architecture,Overview,Boundaries,Threat ModelouPermissions. - Contrats de données : Titres contenant
Data Contract,Data Contracts,Schema,Schemas,Interface,Interfaces,API,Types,PayloadouProtocol. - Cas limites : Titres contenant
Edge Case,Edge Cases,Error Handling,Failure Mode,Failure Modes,Resilience,ConstraintsouFallbacks. - Critères d'acceptation : Titres contenant
Acceptance Criteria,Acceptance Test,Test Matrix,Verification,Testing,Definition of DoneouValidation.
- Portée & Sécurité : Titres contenant
Modèle
# Spécification : <Nom de la fonctionnalité ou du service>
## 1. Portée & Sécurité
### Objectifs & Limites architecturales
- Description détaillée de la portée...
### Sécurité & Modèle de menace
- Vérifications de permissions et limites de sécurité...
## 2. Contrats de données
### Schémas & Interfaces
- Types, signatures API, formats requête/réponse...
## 3. Cas limites & Résilience
### Gestion d'erreur & Replis
- Conditions limites, validation d'entrée, modes de défaillance...
## 4. Critères d'acceptation
### Vérification & Matrice de test
- CA-01 : ...
- CA-02 : ...
Étape 3 : Validation développeur & Implémentation
- Présentez le brouillon
SPEC.mdau développeur pour révision et approbation explicite. - Une fois
SPEC.mdvalidé et respectant les contraintes (>= 300 octets avec les 4 sections), le hookspec-gatekeeperautorisera automatiquement l'écriture des fichiers d'implémentation.