Format de spécification SKILL.md

VérifiéSûr

Décrit le format SKILL.md utilisé par n-skills, conforme à la norme agentskills.io. Spécifie les métadonnées obligatoires et optionnelles, la structure du corps, les ressources incluses et les bonnes pratiques. Utile pour créer ou comprendre des compétences d'IA au format standardisé.

Spar Skills Guide Bot
DocumentationDébutant
5002/06/2026
Claude CodeCodex
#skill-definition#markdown-format#agentskills#documentation-standards

Recommandé pour

Notre avis

Cette compétence définit la structure pour créer des fichiers SKILL.md décrivant les compétences des agents IA, incluant le frontmatter, les sections principales et les ressources regroupées.

Points forts

  • Fournit un format standardisé pour la documentation des compétences.
  • Inclut des champs obligatoires et optionnels dans le frontmatter.
  • Permet de regrouper des ressources supplémentaires comme des scripts et des références.
  • Suit les meilleures pratiques comme placer les déclencheurs en avant.

Limites

  • Ne couvre pas la logique d'implémentation de la compétence elle-même.
  • Se limite à de la documentation textuelle, pas de code exécutable.
  • Peut nécessiter une adaptation pour certains plateformes d'agents IA.
Quand l'utiliser

Quand vous devez créer une définition de compétence réutilisable et bien documentée pour un agent IA selon le standard agentskills.io.

Quand l'éviter

Quand vous cherchez une implémentation prête à l'emploi plutôt qu'un modèle de documentation.

Analyse de sécurité

Sûr
Score qualité90/100

This SKILL.md is purely a documentation specification with no executable code, network operations, or system modifications. It poses no security risk.

Aucun point d'attention détecté

Exemples

Create a code review skill definition
Create a SKILL.md file for a skill that reviews Python code for style and security issues. Include frontmatter with description, triggers like 'review this code', and a setup section requiring pylint and bandit.
Generate a SKILL.md template
Generate a SKILL.md template following the agentskills.io standard with required frontmatter (name, description), a setup section, and an examples section. Use 'example-skill' as the name.
Document a data analysis skill
Write a SKILL.md for a skill that analyzes CSV data and generates summary statistics. Include compatibility for claude-code and codex, and reference a scripts/analyze.py file.

SKILL.md Format Specification

This document describes the SKILL.md format used by n-skills, which follows the agentskills.io standard.

Required Frontmatter

---
name: skill-name           # lowercase, hyphens only
description: |             # Include trigger phrases
  What it does.
  When to use it.
  Requirements.
---

Optional Frontmatter

version: 1.0.0
license: Apache-2.0
author:
  name: Your Name
  github: username
keywords: [tag1, tag2]
compatibility:
  claude-code: true
  codex: true

Body Structure

# Skill Name

## Description (optional)
Expand on the frontmatter description if needed.

## Setup
Any prerequisites or configuration needed.

## Commands/Usage
How to use the skill.

## Examples
Concrete usage examples.

## Advanced
Link to references/ for detailed documentation.

Bundled Resources

Skills can include additional resources:

skill-name/
├── SKILL.md           # Required
├── references/        # Extended documentation
│   └── advanced.md
├── scripts/           # Executable code
│   └── helper.py
└── assets/            # Templates, files for output
    └── template.json

Best Practices

  1. Keep SKILL.md concise - Under 500 lines
  2. Front-load triggers - Put trigger phrases in the description
  3. Use references/ - Move detailed docs out of SKILL.md
  4. Provide examples - Concrete, copy-pasteable examples
  5. Document requirements - API keys, dependencies, etc.
Skills similaires