Specs, documents et révisions
Une spec est une unité de travail numérotée avec jusqu’à cinq documents et un statut.
Le serveur numérote les specs (001, 002, …) quand vous les créez avec create_spec, qui prend un slug de un à quatre mots en minuscules reliés par des tirets. Chaque spec reçoit aussi un nom de branche comme 004-diesel-orm. La spec active est la spec non archivée au numéro le plus élevé, et get_active_spec la renvoie.
Documents
| Document | Contenu |
|---|---|
spec | Quoi et pourquoi, avec les exigences fonctionnelles (FR-1, FR-2, …). |
plan | Comment ce sera construit. |
tasks | De petites tâches avec une phase, un indicateur de parallélisme, des références FR et un contrôle Done when. |
research | Les constats qui répondent aux questions ouvertes. |
validation | Chaque exigence et le test qui la couvre. |
Statut
Une spec est draft, clarified, approved ou archived. Les passages autorisés sont draft vers clarified, clarified vers approved, clarified retour vers draft et approved retour vers draft. Les owners peuvent archiver une spec, et une spec archivée ne peut plus changer de statut.
Seule une spec clarified peut être approuvée, et pas tant qu’elle a des marqueurs ouverts (voir Tâches et marqueurs). Un projet peut aussi exiger plusieurs approbations et interdire d’approuver une spec à ceux qui y ont contribué. Un passage refusé indique les cibles autorisées.
Révisions et conflits
put_document écrit le corps complet d’un document comme une nouvelle révision ; rien n’est modifié sur place. Quand le document existe déjà, passez expected_revision, la révision sur laquelle repose votre modification. Si quelqu’un a écrit avant vous, l’écriture est refusée avec conflict et la révision courante : l’agent la lit, fusionne et écrit de nouveau. Rien n’est écrasé et les deux modifications restent dans l’historique.
list_revisions liste les révisions d’un document ou de la constitution, de la plus récente à la plus ancienne, et get_revision en lit une par son identifiant.