Style de compétences de dépôt

VérifiéSûr

Contrat de style local pour les compétences du dépôt. À utiliser lors de la rédaction, mise à jour ou audit des SKILL.md, métadonnées Codex et contenu.

Spar Skills Guide Bot
DocumentationIntermédiaire
01/08/2026
Claude CodeCodex
#skill-authoring#documentation#metadata#linting#repo-conventions

Recommandé pour

Synthèse automatique

Définit et fait appliquer le contrat de style local des skills du dépôt, couvrant le frontmatter portable, les métadonnées Codex, la divulgation progressive et une formulation neutre vis-à-vis des harnais.

Points forts

  • Donne des règles précises et vérifiables pour le frontmatter, les fichiers de référence et agents/openai.yaml.
  • Sépare clairement les réglages natifs Codex du frontmatter portable.
  • Fournit une checklist d'audit avec commandes de validation et de recherche de termes obsolètes.

Limites

  • Les chemins de plugins et l'exception du plugin workflow déprécié sont propres à ce dépôt.
  • La validation s'appuie sur un script local et sur codex debug, donc sur un environnement équipé.
  • Ne remplace pas les conseils généraux de création de skills, renvoyés à skill-creator.
Quand l'utiliser

À utiliser avant de rédiger, modifier ou auditer un SKILL.md, un agents/openai.yaml ou un skill de référence dans ce dépôt.

Quand l'éviter

À ne pas utiliser pour un skill hors de ce dépôt ni comme guide générique de conception de skills.

Analyse de sécurité

Sûr
Score qualité80/100

The skill is a pure documentation/style contract. It contains no destructive commands, no network fetches, no credential or token handling, and no obfuscated payloads. The only executable suggestions are a local validator script and a read-only prompt-inventory pipeline, both benign. The hardcoded home-directory path is a portability wart, not a security issue.

Points d'attention
  • •References a hardcoded absolute path (`/home/nathan/.codex/skills/.system/skill-creator/scripts/quick_validate.py`) that is author-environment specific; not a risk but reduces portability
  • •Suggests running a local Python validator and a shell pipeline (`codex debug prompt-input ... | rg`); both are read-only inspection commands
Comment cette analyse est faite

Exemples

Audit a skill
Audit plugins/workbench/skills/example/SKILL.md against this repo's skill style and list every frontmatter, metadata, and wording violation.
Add Codex metadata
Create agents/openai.yaml for .agents/skills/release-notes with a display name, short description, default prompt, and implicit invocation policy that matches this repo's contract.
Review before commit
Review my new SKILL.md draft for portable frontmatter only, an under-300-line body, harness-neutral wording, and correct references before I commit it.

name: repo-skill-style description: > Repo-local style contract for skills in this repository. Use when writing, updating, reviewing, or auditing any SKILL.md, agents/openai.yaml, plugin skill, or .agents/skills reference skill in this repo. Enforces portable frontmatter, Codex metadata placement, progressive disclosure, and harness-neutral wording.

Repo Skill Style

Apply this style before editing or auditing skills in this repo. General skill-authoring guidance comes from skill-creator; this skill adds the local distribution contract.

Scope

  • Applies to supported plugin skills under plugins/{agile-workflow,workbench,ux-ui-design,nates-toolkit,agentic-research,agent-coordination,prose-craft}/skills/.
  • Applies to repo-local reference skills under .agents/skills/.
  • Do not modernize plugins/workflow/ unless the user explicitly asks. It is deprecated and kept only for existing installs.

Frontmatter

Use portable frontmatter only:

---
name: skill-name
description: >
  Concise third-person summary that states what the skill does and when to use it.
---
  • name must match the skill directory and use lowercase letters, digits, and hyphens.
  • description must lead with the trigger case, stay under 1024 characters, and avoid first-person voice.
  • Do not add user-invocable, disable-model-invocation, model, effort, argument-hint, allowed-tools, or tool allow-lists to SKILL.md.
  • If an existing skill needs those semantics in a specific harness, put the harness-native setting outside portable frontmatter.

Codex Metadata

Use agents/openai.yaml for Codex picker and invocation behavior:

interface:
  display_name: "Human Title"
  short_description: "25 to 64 character UI summary"
  default_prompt: "Use $skill-name to ..."
policy:
  allow_implicit_invocation: true
  • Include interface when the skill is user-facing or hard to identify from its slug.
  • Set allow_implicit_invocation: true when the model should see and auto-route the skill by description.
  • Set allow_implicit_invocation: false only for deliberate manual-only skills; this hides the skill from the model-visible implicit list.
  • Keep default_prompt short and include the literal $skill-name.

Body Style

  • Keep SKILL.md under 300 lines when practical and under 500 lines always.
  • Move long catalogs, examples, rubrics, and templates into directly linked references/ files.
  • Keep each reference under 200 lines; add a table of contents when a reference exceeds 100 lines.
  • Use harness-neutral wording in shared prose: "structured question tool", "sub-agent", "fresh-context reviewer", "current-source lookup".
  • Avoid Claude-only tool names in portable instructions. If a host needs native ergonomics, put those details in that host's metadata or a clearly labeled reference section.
  • Explain the reason behind sharp guardrails. Prefer crisp constraints over threat language.

Audit Checklist

Before finishing a skill change:

  1. Confirm the target plugin from plugins/ and avoid the deprecated workflow plugin unless explicitly requested.
  2. Validate frontmatter has only name and description.
  3. Check the description is specific, concise, and below 1024 characters.
  4. Verify agents/openai.yaml has correct picker text and invocation policy when present.
  5. Search for stale harness-specific terms in portable surfaces: user-invocable, model:, disable-model-invocation, allowed-tools, AskUserQuestion, SendMessage, general-purpose, and WebSearch.
  6. Run the skill validator when available: python3 /home/nathan/.codex/skills/.system/skill-creator/scripts/quick_validate.py <skill-dir>.
  7. For Codex visibility changes, render the prompt inventory: codex debug prompt-input 'probe skills' | rg '<skill-name>'.

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/repo-skill-style-ms9wny8k/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/repo-skill-style-ms9wny8k' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/repo-skill-style-ms9wny8k/download' --output '.skill-downloads/repo-skill-style-ms9wny8k/SKILL.md.part' && mv '.skill-downloads/repo-skill-style-ms9wny8k/SKILL.md.part' '.skill-downloads/repo-skill-style-ms9wny8k/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/repo-skill-style-ms9wny8k/SKILL.md' && test -s '.skill-downloads/repo-skill-style-ms9wny8k/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/repo-skill-style' && cp -R '.skill-downloads/repo-skill-style-ms9wny8k' '.claude/skills/repo-skill-style'

Codex
test -f '.skill-downloads/repo-skill-style-ms9wny8k/SKILL.md' && test -s '.skill-downloads/repo-skill-style-ms9wny8k/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/repo-skill-style' && cp -R '.skill-downloads/repo-skill-style-ms9wny8k' '.agents/skills/repo-skill-style'

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/repo-skill-style-ms9wny8k'

openskills read 'repo-skill-style-ms9wny8k'

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/repo-skill-style-ms9wny8k/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