Maintien du README

VérifiéSûr

Assure que le README.md du dépôt reste aligné avec le contenu réel du dépôt. Ajoute des sections manquantes sans réécrire.

Spar Skills Guide Bot
DocumentationDébutant
27/07/2026
Claude CodeCursorCodex
#readme#documentation#repo-maintenance#diff-limited#in-place-edit

Recommandé pour

Synthèse automatique

Met à jour le README.md d'un dépôt pour qu'il corresponde au contenu réel du dépôt, au moyen de modifications additives limitées à environ 100 lignes.

Points forts

  • Périmètre strictement borné à README.md : aucun autre fichier n'est modifié et aucun nouveau fichier n'est créé
  • Privilégie les ajouts (nouvelles sections) plutôt que la réécriture, et conserve le ton du README existant
  • S'arrête sans rien changer lorsque le README est déjà exact, ce qui évite les diffs inutiles
  • Exige que chaque ajout soit ancré dans le contenu réel du dépôt, sans inventer de fonctionnalités

Limites

  • Les changements plus importants que ~100 lignes de diff sont seulement signalés dans le message final, pas appliqués
  • Ne lit que la structure de premier niveau du dépôt : les détails enfouis dans les sous-dossiers peuvent échapper à la comparaison
  • Ne corrige pas en profondeur les erreurs factuelles préexistantes du README et ne touche à aucune autre documentation
Quand l'utiliser

À utiliser après l'ajout ou la suppression de fichiers et de dossiers importants, pour réaligner rapidement le README sans refonte complète.

Quand l'éviter

À éviter si vous voulez réécrire entièrement le README, restructurer sa documentation ou documenter en détail des API internes.

Analyse de sécurité

Sûr
Score qualité82/100

The skill is purely documentation-oriented: it reads README.md and the top-level repo listing, then proposes in-place edits scoped strictly to README.md. There are no declared tools, no shell commands, no network calls, no credential handling, and explicit instructions not to create files or delete sections without reason. The only 'power' exercised is reading repo structure, which is benign read-only behavior.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Sync after adding a CLI
We just added a `cli/` directory with an entry point script. Update README.md so it reflects the current repo layout, but keep the diff small.
Check for drift
Compare README.md against the top-level files and directories in this repo and tell me whether it's still accurate — only edit it if something significant is missing.
Missing usage section
The README has no Usage or Development section even though the repo clearly supports both. Add what's justified by the repo contents, staying within ~100 lines of diff.

name: readme-maintainer description: Keep the repo's README.md aligned with the actual contents of the repo.

readme-maintainer

Version: 0.1.0 Source: tokenman library, skills/readme-maintainer/ (temporary — see skills/README.md)

Scope

Operates on README.md only. Does not read or modify other files.

Shape

In-place edit. Prefer additive changes (new sections) over rewrites. If the README already describes the repo accurately, stop without edits.

Size limit

Diff must be ≤ ~100 lines. If a bigger change is warranted, stop and surface the observation in your final message instead of making the edit.

Deterministic gate hints

  • Only README.md should appear in the diff.
  • No new files.
  • No deletions of entire top-level sections without an explicit reason.

Evaluator criteria (medium strictness)

  • Changes stay scoped to README.md.
  • Additions are factually grounded in other repo contents (do not invent features).
  • Tone is consistent with the existing README.

Typical token budget

~15 000 tokens per run (generator + evaluator combined).

Instructions

When invoked:

  1. Read README.md.
  2. Read the repo structure (top-level files and directories) to compare what's documented against what's present.
  3. If the README omits something significant (e.g. missing Usage, Install, or Development section that the repo clearly supports), propose an addition.
  4. If the README is already aligned with the repo, stop without edits and say so in your final message.
  5. Stay within the size limit. If you think a bigger change is needed, summarize the finding instead of making it.

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

Cursor
test -f '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && test -s '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/readme-maintainer' && cp -R '.skill-downloads/readme-maintainer-ms2s7c9h' '.cursor/skills/readme-maintainer'

Codex
test -f '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && test -s '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/readme-maintainer' && cp -R '.skill-downloads/readme-maintainer-ms2s7c9h' '.agents/skills/readme-maintainer'

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/readme-maintainer-ms2s7c9h'

openskills read 'readme-maintainer-ms2s7c9h'

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/readme-maintainer-ms2s7c9h/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