Skills Guide

Synchro documentation

VérifiéSûr

Vérifier et mettre à jour la documentation du dépôt lorsque le comportement, les commandes ou les preuves de validation changent.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationIntermédiaire
23/07/2026
Claude CodeCursorWindsurf
#docs-sync#readme#decision-records#code-documentation-sync

Recommandé pour

Claude CodeCursorDocumentation automatiqueWindsurf

Synthèse automatique

Met à jour la documentation du projet en synchronisation avec les changements de code, notamment README, DECISIONS.md et ADR.

Points forts

  • Assure la cohérence entre code et documentation
  • Évite de laisser des décisions uniquement dans les conversations
  • Structure les mises à jour documentaires avec des règles claires

Limites

  • Ne réécrit pas automatiquement la documentation existante si non liée
  • Peut nécessiter une relecture humaine pour la formulation
  • Se concentre sur les aspects opérationnels, pas sur la doc utilisateur avancée
Quand l'utiliser

Lorsque vous modifiez un comportement public, une commande, une validation ou une prise de décision durable dans le code.

Quand l'éviter

Pour une documentation purement cosmétique ou non liée à des changements de code récents.

Analyse de sécurité

Sûr
Score qualité90/100

The skill only provides documentation update guidelines with no executable commands, network activity, or file system modifications beyond editing docs, presenting no security risk.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Update README after adding a new command
I added a new CLI command `analyze` that takes a file path and outputs statistics. Update README.md and any relevant docs under docs/ to document this command, including usage example and output format.
Record a decision in DECISIONS.md
We decided to switch from using SQLite to PostgreSQL for the data store. Add a new decision record in docs/DECISIONS.md explaining the rationale, date, and what remains out of scope.

name: docs-sync description: Use when behavior, setup, validation, public wording, data provenance, or workflow commands change and repository documentation may need to be updated.

Docs Sync

  • Check README.md, docs/DECISIONS.md, relevant docs under docs/, and any ADRs.
  • Update docs in the same change as code when public behavior, commands, assumptions, or validation evidence changes.
  • Record durable decisions in docs/DECISIONS.md or a new ADR; do not bury decisions only in chat.
  • Keep docs concise and operational: what changed, why, how to run it, and what remains out of scope.
  • Avoid rewriting unrelated docs or changing historical decisions except to add a dated superseding note.

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

Cursor
test -f '.skill-downloads/docs-sync-mrwakfra/SKILL.md' && test -s '.skill-downloads/docs-sync-mrwakfra/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/docs-sync' && cp -R '.skill-downloads/docs-sync-mrwakfra' '.cursor/skills/docs-sync'

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/docs-sync-mrwakfra'

openskills read 'docs-sync-mrwakfra'

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/docs-sync-mrwakfra/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