CommunityRédaction et éditiongithub.com

Al0olo/Village-d'agents

Rédigez ou modifiez de la documentation, des README, des descriptions de PR et des textes de recherche dans le style de ce dépôt. À utiliser chaque fois que vous produisez du texte destiné à des lecteurs.

Qu'est-ce que Village-d'agents ?

Cette compétence définit un style d'écriture clair et concis pour la documentation technique, les README, les descriptions de pull requests et la prose de recherche dans un dépôt. Elle met l'accent sur des phrases courtes, une idée par paragraphe, et des exemples concrets (nombres, fichiers, commandes) plutôt que des généralités. Elle interdit les narrations processuelles, l'auto-référencement, le vocabulaire creux (comme « robuste » ou « complet »), et exige que chaque répertoire contienne un `README.md` pour les humains et un `AGENTS.md` pour les agents. La compétence est conçue pour être utilisée par des agents d'IA (comme Claude Code, Cursor, Codex) sur n'importe quel dépôt, garantissant une prose cohérente, lisible et orientée vers le lecteur.

Compatible avec~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Al0olo/Agents-village/tree/HEAD/.claude/skills/docs-style

Installed? Explore more Rédaction et édition skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Demander à votre IA préférée

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

Documentation

Style de documentation

  • Commencez par l'essentiel. Une idée par paragraphe. Phrases courtes.
  • Concret plutôt que général : un nombre, un fichier, une commande, un nom.
  • Pas de narration processuelle ni d'auto-référencement dans les documents destinés aux lecteurs.
  • Pas de remplissage : supprimez « il est important de noter », « afin de », « robuste », « exploiter », « complet », « transparent ».
  • Tableaux uniquement pour les comparaisons ; listes uniquement pour les étapes ou les éléments parallèles.
  • Indiquez l'incertitude une fois, là où elle s'applique, et dites ce qui la résoudrait.
  • Chaque répertoire contient un README.md (ce que c'est, pour les humains) et un AGENTS.md (règles sur lesquelles un agent peut agir). Mettez à jour les deux lorsque l'objectif ou les règles du répertoire changent.
  • Les documents destinés aux lecteurs portent une ligne de signature et une date au maximum. L'état opérationnel va dans docs/HANDOFF.md et docs/handoff/LOG.md.
  • Relisez-le comme un étranger. Supprimez tout ce qu'il sauterait.

Individual skills in this repo

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

Skills associés