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
4002/06/2026
Claude Code
#documentation#specification#code-documentation#project-documentation#workflow

Recommandé pour

Notre avis

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é

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
Skills similaires