write-a-skill

Créer de nouvelles compétences d'agent avec une structure appropriée, une divulgation progressive et des ressources groupées. Utiliser lorsque l'utilisateur souhaite créer, rédiger ou construire une nouvelle compétence.

npx skills add https://github.com/sanity-io/sanity --skill write-a-skill

Writing Skills

Process

  1. Gather requirements - ask user about:

    • What task/domain does the skill cover?
    • What specific use cases should it handle?
    • Does it need executable scripts or just instructions?
    • Any reference materials to include?
  2. Draft the skill - create:

    • SKILL.md with concise instructions
    • Additional reference files if content exceeds 500 lines
    • Utility scripts if deterministic operations needed
  3. Review with user - present draft and ask:

    • Does this cover your use cases?
    • Anything missing or unclear?
    • Should any section be more/less detailed?

Skill Structure

skill-name/
├── SKILL.md           # Main instructions (required)
├── REFERENCE.md       # Detailed docs (if needed)
├── EXAMPLES.md        # Usage examples (if needed)
└── scripts/           # Utility scripts (if needed)
    └── helper.js

SKILL.md Template

---
name: skill-name
description: Brief description of capability. Use when [specific triggers].
---

# Skill Name

## Quick start

[Minimal working example]

## Workflows

[Step-by-step processes with checklists for complex tasks]

## Advanced features

[Link to separate files: See [REFERENCE.md](REFERENCE.md)]

Description Requirements

The description is the only thing your agent sees when deciding which skill to load. It's surfaced in the system prompt alongside all other installed skills. Your agent reads these descriptions and picks the relevant skill based on the user's request.

Goal: Give your agent just enough info to know:

  1. What capability this skill provides
  2. When/why to trigger it (specific keywords, contexts, file types)

Format:

  • Max 1024 chars
  • Write in third person
  • First sentence: what it does
  • Second sentence: "Use when [specific triggers]"

Good example:

Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when user mentions PDFs, forms, or document extraction.

Bad example:

Helps with documents.

The bad example gives your agent no way to distinguish this from other document skills.

When to Add Scripts

Add utility scripts when:

  • Operation is deterministic (validation, formatting)
  • Same code would be generated repeatedly
  • Errors need explicit handling

Scripts save tokens and improve reliability vs generated code.

When to Split Files

Split into separate files when:

  • SKILL.md exceeds 100 lines
  • Content has distinct domains (finance vs sales schemas)
  • Advanced features are rarely needed

Review Checklist

After drafting, verify:

  • Description includes triggers ("Use when...")
  • SKILL.md under 100 lines
  • No time-sensitive info
  • Consistent terminology
  • Concrete examples included
  • References one level deep

Plus de skills de sanity-io

tdd
sanity-io
Développement piloté par les tests avec boucle rouge-vert-refactorisation. À utiliser lorsque l'utilisateur souhaite créer des fonctionnalités ou corriger des bugs en utilisant le TDD, mentionne "rouge-vert-refactorisation", veut…
performance-optimization
sanity-io
Optimise les performances de l'application. À utiliser lorsque des exigences de performance existent, lorsque vous suspectez des régressions de performance, ou lorsque les Core Web Vitals ou les temps de chargement…
content-experimentation-best-practices
sanity-io
Conseils structurés pour concevoir, exécuter et analyser des expériences de contenu afin d’améliorer la conversion et l’engagement. Couvre les cadres d’hypothèses, la sélection des métriques, le calcul de la taille de l’échantillon et les tests de signification statistique pour les expériences A/B et multivariées. Inclut des ressources détaillées sur les valeurs p, les intervalles de confiance, l’analyse de puissance et les méthodes bayésiennes pour interpréter les résultats. Fournit des modèles d’intégration CMS pour gérer les variantes au niveau du champ et connecter des systèmes externes...
content-modeling-best-practices
sanity-io
Conseils de modélisation de contenu structuré pour la conception de schémas, la réutilisabilité et la diffusion multicanal. Couvre les principes fondamentaux : traiter le contenu comme des données plutôt que comme des pages, maintenir des sources uniques de vérité, concevoir pour les canaux futurs et optimiser les flux de travail des éditeurs. Inclut des cadres de décision pour les références par rapport aux objets intégrés, la séparation des préoccupations et les modèles de réutilisation du contenu. Fournit des conseils sur la taxonomie et la classification pour les approches plates, hiérarchiques et à facettes. S'applique à...
portable-text-conversion
sanity-io
Convertir du contenu HTML et Markdown en blocs Portable Text pour Sanity. À utiliser lors de la migration de contenu depuis des CMS hérités, de l'importation de HTML ou Markdown dans Sanity,…
portable-text-serialization
sanity-io
Rendre et sérialiser le Portable Text en React, Svelte, Vue, Astro, HTML, Markdown et texte brut. Utiliser lors de l'implémentation du rendu Portable Text dans n'importe quel frontend…
sanity-best-practices
sanity-io
We need to translate the given text from English to French. The text is a description of a directory item for an agent skill named "sanity-best-practices". The instruction says to preserve product names, protocol names, URLs, numbers, technical terms. Also, do not include the name unless it appears in the source text. The name "sanity-best-practices" does not appear in the source text, so we don't include it. We translate only the text inside <text>. The text is a single paragraph. We need to translate it accurately, keeping terms like "Sanity CMS", "Next.js", "Nuxt", "Astro", "Remix", "SvelteKit", "Angular", "GROQ", "Visual Editing", "Portable Text", "TypeGen" as they are. Also numbers like "10+". The translation should be natural French. Let's break down the text: "Comprehensive best practices and integration guides for Sanity CMS development across frameworks and topics. Covers 10+ framework integrations including Next.js,
sanity-migration
sanity-io
Planifie, implémente et révise les migrations depuis d’autres CMS et systèmes de contenu vers Sanity. À utiliser lors d’une migration ou d’un replatforming vers Sanity depuis AEM, Adobe Experience Manager, Contentful, Strapi, Webflow, WordPress, Payload, Drupal, fichiers Markdown/MDX/frontmatter, exports WXR/XML, API CMS, dumps de base de données, HTML statique, ou lors de la conception de workflows d’extraction, transformation, conversion en Portable Text, migration de ressources, redirections, validation et basculement.
data-analysisdatabasedevelopment