Skills Guide

Mise à jour de la documentation

VérifiéSûr

Cette compétence met à jour la documentation et les fichiers README pour refléter les modifications du code. Elle couvre les types de documentation courants tels que README, CHANGELOG, documentation API, configuration et architecture. Utilisez-la après avoir terminé une fonctionnalité ou sur demande pour "mettre à jour la documentation", mais pas pour les modifications de code ou la lecture exploratoire.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationDébutant
02/06/2026
Claude Code
#documentation#readme#changelog#api-docs#git

Recommandé pour

Claude CodeDocumentation automatiqueAutomatisation Git

Synthèse automatique

Synchronise la documentation avec les modifications du code pour garantir l'exactitude des documents.

Points forts

  • Automatisation de la mise à jour des fichiers README, CHANGELOG et documentation API.
  • Utilisation de scripts intégrés pour journaliser et suivre l'état des modifications.
  • Vérification de l'exactitude des exemples de code et des liens.

Limites

  • Nécessite un accès aux fichiers et à Git pour détecter les changements.
  • Ne met pas à jour automatiquement les captures d'écran ; nécessite une intervention manuelle.
Quand l'utiliser

Utilisez cette compétence après avoir terminé une fonctionnalité ou lorsque vous devez mettre à jour la documentation existante.

Quand l'éviter

Ne l'utilisez pas pour effectuer des modifications de code ou pour simplement lire la documentation sans la mettre à jour.

Analyse de sécurité

Sûr
Score qualité85/100

The skill only uses safe built-in tools (Read, Write, Edit, Glob, Grep) and suggests standard git and shell commands for documentation updates. No destructive, exfiltrating, or obfuscated actions are present.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Post-feature documentation
Update the docs for the new auth feature
Quick README update
Add installation instructions to README

name: updating-documentation description: > Update documentation and README files after feature work. Use when user says "update docs", "write readme", "document this", "add docs", "update documentation", or after completing a feature that needs doc updates. Do NOT use for: code changes (use implementing-features), reading docs for understanding (use exploring-codebase). compatibility: "Requires Claude Code with file access." allowed-tools: [Read, Write, Edit, Glob, Grep] metadata: author: agentic-framework version: "0.38.0"

Updating Documentation

Sync documentation with code changes to keep docs accurate and current.

Instructions

Step 1: Identify What Changed

Check what code was modified:

git diff --stat HEAD~1

Determine which docs need updating based on the changes.

Step 2: Update Relevant Docs

Common documentation updates:

  • README.md: New features, changed setup steps, updated examples
  • CHANGELOG.md: Entry for the version with what changed
  • API docs: New endpoints, changed parameters, updated responses
  • Configuration docs: New settings, changed defaults
  • Architecture docs: Structural changes, new components

Step 3: Verify Accuracy

  • Code examples in docs should be runnable
  • Links should point to existing files
  • Version numbers should be current
  • Screenshots should reflect current UI (if applicable)

Step 4: Use Framework Scripts

For framework-managed docs:

bash .agentic/tools/journal.sh "Topic" "Done" "Next" "Blockers"
bash .agentic/tools/status.sh focus "Current state"

Examples

Example 1: Post-feature documentation User says: "Update the docs for the new auth feature" Steps taken:

  1. Read the auth feature code to understand what was added
  2. Update README.md with new auth section
  3. Add CHANGELOG entry: "Added JWT authentication"
  4. Update API docs with new auth endpoints Result: Documentation matches the implemented feature.

Example 2: Quick README update User says: "Add installation instructions to README" Steps taken:

  1. Read existing README structure
  2. Check package.json/setup.py for install commands
  3. Write installation section with prerequisites and steps Result: Clear installation instructions added to README.

Troubleshooting

Docs out of sync with code Cause: Code changed without doc updates. Solution: Run git log --oneline to find recent changes, then update docs for each relevant change.

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

Environnement déclaré par l’auteur : Requires Claude Code with file access.

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

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/updating-documentation-mma3jspj'

openskills read 'updating-documentation-mma3jspj'

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/updating-documentation-mma3jspj/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

Rédaction de docs Supabase

Documentation

Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.

Claude CodeintermediateSûr 108,544
Skills Guide Bot

Créer un enregistrement de décision d'architecture

Documentation

Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.

Claude CodeintermediateSûr 69,659
Skills Guide Bot

Mise à jour de plan avec recherche approfondie

Documentation

Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.

Claude CodeadvancedSûr 248,015
Skills Guide Bot