Documentation des spécifications

VérifiéSûr

Crée des fichiers de spécification Markdown dans le répertoire specs/ pour documenter le travail récemment terminé. Utilisez-le après avoir implémenté des fonctionnalités, modifié l'architecture ou créé des expériences immersives afin de structurer la documentation technique.

Spar Skills Guide Bot
DocumentationIntermédiaire
02/06/2026
Claude Code
#documentation#specification#code-documentation#project-documentation#workflow

Recommandé pour

Synthèse automatique

Crée des fichiers de spécification Markdown dans un dossier specs/ pour documenter le travail récent effectué lors d'une session.

Points forts

  • Automatise la documentation post-développement
  • Structure claire avec sections standardisées
  • Support pour des types variés (features, architecture, immersif)
  • Mise à jour automatique des README associés

Limites

  • Nécessite une conversation précédente significative pour fonctionner
  • Ne couvre pas la documentation de code déjà existant en dehors de la session
Quand l'utiliser

À la fin d'une session de développement pour capturer les décisions et les détails d'implémentation.

Quand l'éviter

Si aucun travail significatif n'a été effectué ou si la documentation doit être maintenue dans un outil externe.

Analyse de sécurité

Sûr
Score qualité85/100

The skill only provides instructions for the AI to generate documentation files; it does not execute commands, manipulate sensitive data, or interact with external systems.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

General spec creation
/spec
Named feature spec
/spec user-authentication
Immersive experience spec
/spec immersive

name: spec description: Document recently completed work by creating spec .md files in specs/ directory

/spec - Document Recently Completed Work

Create specification documentation for recently completed work in this session.

Instructions

When the user invokes /spec, you should:

  1. Review the conversation to identify what was recently built, fixed, or modified

  2. Determine the appropriate spec type based on the work:

    • Immersive experience → Create in specs/immersive/
    • New feature/flow → Create in specs/features/
    • Architecture change → Update specs/architecture.md
    • General spec → Create in specs/
  3. Create the spec file with this structure:

    # [Feature Name]
    
    **File(s):** `path/to/file.swift`
    **Type:** [View | Manager | Component | Flow]
    **Purpose:** One-line description
    
    ---
    
    ## Overview
    Brief description of what this does and why it exists.
    
    ## Implementation
    Key code patterns, setup, and usage.
    
    ## Integration Points
    How this connects to other parts of the codebase.
    
    ## Usage Example
    Code snippets showing how to use this feature.
    
  4. For immersive/RealityView specs, include:

    • RealityView structure (content, update, attachments)
    • 3D entities created/modified
    • ARKit integration (hand tracking, image tracking)
    • Collision detection setup
    • Attachment positions and sizes
  5. Update the relevant README.md if adding to a subdirectory

Arguments

  • /spec [name] - Create spec with specific name
  • /spec immersive - Force creation in specs/immersive/
  • /spec update - Update existing spec files based on recent changes

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

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/specification-documentation-mm78nnuq'

openskills read 'specification-documentation-mm78nnuq'

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/specification-documentation-mm78nnuq/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