Système de documentation standardisé

VérifiéSûr

Fournit des commandes pour initialiser et maintenir une structure de documentation standardisée. Permet de créer des spécifications de fonctionnalités, des documents d'architecture, des journaux de modifications, des feuilles de route, des guides et des suivis de tâches avec validation des en-têtes. Utile pour les équipes ayant besoin de pratiques documentaires cohérentes.

Spar Skills Guide Bot
DocumentationDébutant
02/06/2026
Claude Code
#documentation#standards#templates#markdown

Recommandé pour

Synthèse automatique

Crée et maintient une documentation standardisée avec des modèles pour différents types de documents.

Points forts

  • Impose une structure cohérente.
  • Fournit des modèles pour les types de documents courants.
  • Inclut la validation des en-têtes.
  • S'intègre au flux de travail du projet.

Limites

  • Dépend de normes définies par l'utilisateur.
  • Peut ne pas couvrir tous les besoins documentaires.
  • Nécessite une invocation manuelle.
Quand l'utiliser

Lorsque vous démarrez un nouveau projet ou devez maintenir une documentation cohérente au sein d'une équipe.

Quand l'éviter

Pour une documentation très dynamique nécessitant des modifications non standard fréquentes ou lorsqu'un outil de documentation dédié est déjà utilisé.

Analyse de sécurité

Sûr
Score qualité75/100

The skill only uses file manipulation tools (Read, Write, Edit, Glob, Grep) for documentation tasks. There are no destructive commands, network access, or obfuscated payloads. No security risks are introduced by the skill itself.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Initialize documentation structure
/docs init
Create a feature specification
/docs new feature
Validate documentation headers
/docs validate

name: docs description: Documentation system with standards and templates user-invocable: true allowed-tools: Read, Write, Edit, Glob, Grep

Documentation Skill

Create and maintain standardized documentation.

Commands

  • /docs init - Initialize docs structure
  • /docs new [type] - Create new document
  • /docs status - Show docs status
  • /docs validate - Validate headers

Document Types

| Type | Folder | Purpose | |------|--------|---------| | feature | features/ | Feature specs | | arch | architecture/ | Architecture docs | | changelog | changelog/ | Progress tracking | | roadmap | roadmap/ | Planning | | guide | guides/ | How-to guides | | todo | todo/ | Task tracking |

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/standardized-documentation-system-mm8o5279/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/standardized-documentation-system-mm8o5279' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/standardized-documentation-system-mm8o5279/download' --output '.skill-downloads/standardized-documentation-system-mm8o5279/SKILL.md.part' && mv '.skill-downloads/standardized-documentation-system-mm8o5279/SKILL.md.part' '.skill-downloads/standardized-documentation-system-mm8o5279/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.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Read, Write, Edit, Glob, Grep

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/standardized-documentation-system-mm8o5279/SKILL.md' && test -s '.skill-downloads/standardized-documentation-system-mm8o5279/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs' && cp -R '.skill-downloads/standardized-documentation-system-mm8o5279' '.claude/skills/docs'

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/standardized-documentation-system-mm8o5279'

openskills read 'standardized-documentation-system-mm8o5279'

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/standardized-documentation-system-mm8o5279/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