Rédaction de documentation

VérifiéSûr

Rédige ou met à jour la documentation technique (spécifications, README, API, décisions).

Spar Skills Guide Bot
DocumentationIntermédiaire
30/07/2026
Claude Code
#documentation#readme#api-docs#specs#markdown

Recommandé pour

Synthèse automatique

Met à jour ou rédige la documentation d'un périmètre donné (specs SDD, README de contexte, doc API SpringDoc, décisions d'architecture) en se basant sur le code réel.

Points forts

  • Couvre quatre cas distincts et nommés : mise à jour de SDD, README de bounded context, doc API et décision d'architecture
  • Impose de lire d'abord les sources et la documentation existante avant de rédiger
  • Interdit explicitement d'inventer un comportement : ne documente que ce que le code fait réellement
  • Demande de réutiliser la terminologie du bounded context et de produire du Markdown UTF-8

Limites

  • suppose des conventions de projet précises (docs/specs/SDD_<slug>.md, summary.md) qui doivent exister ou être adaptées
  • L'étape de vérification des annotations SpringDoc reste déclarative : rien ne garantit que la doc générée compile ou s'affiche correctement
  • Nécessite un périmètre passé en argument ; sans lui, la skill n'a pas de cible définie
Quand l'utiliser

À utiliser lorsqu'une fonctionnalité vient d'être implémentée ou modifiée et que les specs, le README ou la doc API doivent être réalignés sur le code.

Quand l'éviter

À éviter pour rédiger de la documentation marketing, des tutoriels utilisateur ou des guides ne s'appuyant pas sur le code source du dépôt.

Analyse de sécurité

Sûr
Score qualité78/100

The skill only instructs reading source files and updating documentation; it contains no destructive commands, network calls, exfiltration, or obfuscation. It does not declare any execution tools.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Mettre à jour la spec SDD
/docs order-cancellation — the implementation diverged from docs/specs/SDD_order-cancellation.md, update the spec to match what the code does now.
README de contexte
/docs billing context — the summary.md and README.md for the billing bounded context are outdated, regenerate them from the current source files.
Vérifier la doc API
/docs payment API — check that the SpringDoc @Operation and @ApiResponse annotations are accurate and complete for the payment controllers.

name: docs description: "문서를 작성하거나 최신 상태로 업데이트합니다. '문서 작성', '문서화', 'README 업데이트', 'API 문서', 'SDD 업데이트', '주석 추가', 'docs', 'document', 'README', 'API docs', 'update spec', 'write documentation' 등의 요청에 반응합니다."

Update or draft documentation for the specified scope.

Scope: $ARGUMENTS

Instructions

  1. Read the relevant source files and any existing docs for the scope.
  2. Determine what documentation is needed:
    • SDD update: if the implementation diverged from docs/specs/SDD_<slug>.md, update the spec to match reality.
    • Context README: if summary.md or README.md is missing or outdated for a bounded context, create/update it.
    • API docs: verify SpringDoc annotations (@Operation, @ApiResponse) are accurate and complete.
    • Architecture decision: if a notable design decision was made, document it with context and trade-offs.
  3. Keep language consistent with the existing bounded context terminology.
  4. All output must be UTF-8 Markdown.
  5. Do not invent behavior — document only what the code actually does.

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

openskills read 'documentation-ms71b40g'

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/documentation-ms71b40g/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