CommunityProductivité et collaborationgithub.com

mtai0524/claude-skills

Maintenir le README.md et la documentation du projet synchronisés lors de l'ajout de fonctionnalités, de modifications de la configuration ou de l'installation, ou lorsque l'utilisateur demande une mise à jour des docs.

Qu'est-ce que claude-skills ?

Cette compétence aide à maintenir automatiquement la synchronisation de `README.md` et de la documentation du projet lorsque des changements sont apportés aux fonctionnalités, à la configuration ou aux étapes d'installation. Elle est particulièrement utile pour les développeurs utilisant des agents IA comme Claude Code, Cursor ou Codex, car elle garantit que la documentation reste à jour sans intervention manuelle excessive. La compétence s'applique après chaque ajout de fonctionnalité, modification des étapes de configuration, ajout de variables d'environnement, ou à la demande de l'utilisateur. Elle suit des règles strictes : ne modifier que les sections concernées, vérifier que toutes les commandes documentées fonctionnent, et utiliser un langage concis en anglais sans marketing. La documentation doit couvrir brièvement la description du projet, les prérequis et étapes d'installation, les commandes copiables, la configuration des variables d'environnement avec leurs exemples, ainsi que des exemples d'utilisation des fonctionnalités principales.

Compatible avec✓Claude Code~Codex CLI~Cursor
Part ofAgent Workflows
npx skills add https://github.com/mtai0524/claude-skills/tree/HEAD/skills/docs-readme

Installed? Explore more Productivité et collaboration skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

Voir l'original→Voir toutes les compétences

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Documentation

Docs & README

Lorsqu'un changement affecte la manière dont quelqu'un installe, exécute, configure ou utilise le projet, mettez à jour README.md dans le même changement.

Le README doit couvrir brièvement :

  • Ce que fait le projet (1-2 phrases).
  • Les prérequis et les étapes d'installation.
  • Comment exécuter, tester et construire — commandes copiables.
  • Configuration : chaque variable d'environnement avec son objectif et un exemple de valeur (jamais de secrets réels).
  • Exemples d'utilisation courts pour les fonctionnalités principales.

Règles :

  • Modifiez uniquement les sections concernées par le changement ; ne réécrivez pas l'intégralité du fichier.
  • Vérifiez que chaque commande que vous documentez fonctionne réellement.
  • Anglais, phrases courtes, pas de langage marketing.

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

mtai0524/claude-skills

Branch naming convention and the rule to branch before changing code on the default branch (main/master). Use when starting new work, creating a branch, or when about to edit code while on the default branch.

mtai0524/claude-skills

Update CHANGELOG.md from commits since the last tag, following Keep a Changelog. Use when the user asks to update the changelog or prepare a release.

mtai0524/claude-skills

Write git commit messages in Conventional Commits format. Use whenever creating a commit, when the user asks for a commit message, and at the end of every task that changed files (to propose the commit message).

mtai0524/claude-skills

Systematic debugging that finds and fixes the root cause instead of patching symptoms. Use for any bug, error, failing test, or unexpected behavior.

Skills associés

steipete/gemini

Gemini CLI one-shot prompts, summaries, generation, skills, hooks, MCP, or Gemma routing.

community

steipete/gh-issues

Fetch GitHub issues, select candidates, spawn background fix agents, open PRs, and optionally process PR review comments.

community

steipete/skill-creator

Create, edit, audit, tidy, validate, or restructure AgentSkills and SKILL.md files.

community

steipete/clawhub

Search, install, update, sync, or publish agent skills with the ClawHub CLI and registry.

community

steipete/coding-agent

Delegate coding work to Codex, Claude Code, or OpenCode as background workers; not simple edits or read-only code lookup.

community

steipete/mcporter

List, configure, authenticate, call, and inspect MCP servers/tools with mcporter over HTTP or stdio.

community
← More Productivité et collaboration skills