Générer et valider des RFC

VérifiéSûr

Génère et valide des RFC ArenaQuest selon un standard d'équipe : fichier numéroté, en-tête de métadonnées, sections canoniques et index README.

Spar Skills Guide Bot
DocumentationIntermédiaire
11/09/2026
Claude Code
#rfc#documentation#templates#validation#node-scripts

Recommandé pour

Synthèse automatique

Scaffolde et valide les RFC du dépôt ArenaQuest selon le standard maison, via deux scripts Node sans dépendances.

Points forts

  • Génère automatiquement le prochain numéro de RFC (NNNN-titre-kebab.md) et ajoute la ligne d'index dans le README
  • Le script de validation check-rfc.mjs distingue les violations bloquantes (exit 1) des sections recommandées manquantes (avertissement, exit 0)
  • S'appuie sur un template.md qui documente le contenu attendu de chaque section
  • Options CLI explicites pour le statut, la date, l'auteur et le répertoire cible

Limites

  • Fortement couplé à l'arborescence ArenaQuest (docs/product/RFCs) et à ses conventions de nommage
  • Le standard est seulement indicatif pour les anciens RFC (0001 en portugais, 0003 avec date intégrée au statut)
  • Le symlink .claude/skills et le pont WSL peuvent provoquer des erreurs ENOTDIR ou masquer les codes de sortie
Quand l'utiliser

À utiliser dès qu'il faut rédiger, créer ou vérifier un RFC dans docs/product/RFCs de ce dépôt.

Quand l'éviter

À éviter pour documenter des propositions hors du dépôt ArenaQuest ou dans un projet qui n'utilise pas ce format de RFC.

Analyse de sécurité

Sûr
Score qualité92/100

The skill instructs running two local Node scripts that scaffold and validate RFC documents using only the standard library. There is no network access, no destructive commands, no exfiltration, and no obfuscation. The scripts operate on repository files for a legitimate documentation workflow.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Scaffold a new RFC
Create a new RFC titled 'Enrollment exclusions and visibility', author raphaelsilva, status Draft, then show me the created file path.
Validate one RFC
Check docs/product/RFCs/0005-enrollment-exclusions-and-visibility.md against the RFC standard and tell me which sections are missing.
Validate all RFCs
Run the RFC validation over every file in docs/product/RFCs and list the hard violations that would fail CI.

name: write-rfc description: Scaffold and validate ArenaQuest RFCs against the house standard so every proposal in docs/product/RFCs follows the same structure (numbered file, metadata header, canonical sections, README index row). Triggers: write rfc, create rfc, new rfc, draft rfc, scaffold rfc, rfc template, rfc standard, validate rfc, check rfc

ArenaQuest keeps formal proposals in docs/product/RFCs/ as NNNN-<kebab-title>.md, indexed by docs/product/RFCs/README.md. This skill enforces that standard with two dependency-free Node scripts:

  • new-rfc.mjs — scaffolds the next-numbered RFC from template.md and appends its index row to the README.
  • check-rfc.mjs — validates one or all RFCs against the standard; non-zero exit on a hard violation, so it drops into a pre-commit hook or CI.

Paths below are relative to the repo root (docs/product/RFCs, the scripts under .claude/skills/write-rfc/). Run them from the repo root.

The .claude/skills/ directory is a symlink to .agents/skills/. It resolves fine for the Node runtime (Linux). The Windows \\wsl.localhost bridge can't traverse the symlink — if a tool errors with ENOTDIR / Input/output error on .claude/skills/..., use the real path .agents/skills/write-rfc/... instead. Both point at the same files.

The standard

Every RFC has, in this order:

  1. Filename NNNN-<kebab-title>.md — 4-digit zero-padded, sequential.
  2. Title # RFC NNNN: <Title> — number matches the filename.
  3. Metadata block (bold fields): **Status:**, **Author:**, **Date:** (PT Autor: / Data: accepted), plus optional **Revised:** and an **Affected:** file list. Then a --- divider.
  4. Sections (##): Summary, Motivation, Goals & Non-Goals, Current State (omit if greenfield), Proposed Design, Alternatives Considered, Implementation Plan, Tradeoffs & Risks, Success Criteria, Open/Resolved Decisions, References. See template.md for the prose guidance per section.
  5. README index row in docs/product/RFCs/README.md.

Status lifecycle: Draft → Proposed → Approved → In Progress → Implemented/Done/Completed; or Rejected / Superseded.

Create a new RFC (agent path)

node .claude/skills/write-rfc/new-rfc.mjs "Title of the proposal" --author raphaelsilva

Prints the created path (e.g. docs/product/RFCs/0007-title-of-the-proposal.md) and adds the README index row. Options: --status (default Draft), --date YYYY-MM-DD (default today), --author (default git config user.name), --dir (default docs/product/RFCs). Then fill in each ## section — the template body explains what belongs in each.

Validate (agent path)

Check every RFC in the directory:

node .claude/skills/write-rfc/check-rfc.mjs

Check a single file (use this on the RFC you just wrote):

node .claude/skills/write-rfc/check-rfc.mjs docs/product/RFCs/0005-enrollment-exclusions-and-visibility.md

Output: ✓ clean, ⚠ recommended section missing (advisory — exit 0), ✗ hard violation (exit 1). ERROR = wrong filename, missing/mismatched # RFC NNNN title, missing Status/Author/Date metadata, or not linked from the README index. warn = a recommended ## section is absent (older RFCs predate the full skeleton, so these don't block).

Gotchas

  • .claude/skills is a symlink (→ .agents/skills). Native file tools reaching it over the Windows bridge throw Input/output error; run scripts through the WSL Node runtime, or edit files via .agents/skills/write-rfc/.
  • Exit codes are swallowed by the wsl.exe … bash -c '… ; echo $?' bridge — $? reads as 0 even when Node exited non-zero. To observe the real result use &&/|| evaluated inside WSL: node …/check-rfc.mjs && echo PASS || echo FAIL.
  • The standard is advisory for legacy RFCs. 0001 is Portuguese (Autor:/ Data: — accepted) and 0003 embeds its date inside the Status line, so check-rfc.mjs flags 0003 as ✗ missing Date. That is a real, known gap in an existing doc, not a script bug — don't "fix" the validator to hide it.
  • Numbering reads the directory, not the README. If a number was skipped or a draft file deleted, the next number follows the highest existing NNNN-*.md, not the index.

Files

  • .claude/skills/write-rfc/new-rfc.mjs — scaffolder (Node, stdlib only).
  • .claude/skills/write-rfc/check-rfc.mjs — validator (Node, stdlib only).
  • .claude/skills/write-rfc/template.md — the canonical section skeleton with per-section prose guidance; new-rfc.mjs fills its {{...}} placeholders.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/scaffold-and-validate-rfcs-mtwgrt1e/download' --output '.skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e/SKILL.md.part' && mv '.skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e/SKILL.md.part' '.skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e/SKILL.md' && test -s '.skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/write-rfc' && cp -R '.skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e' '.claude/skills/write-rfc'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e'

openskills read 'scaffold-and-validate-rfcs-mtwgrt1e'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/scaffold-and-validate-rfcs-mtwgrt1e/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires