crafting-effective-readmes

SKILL.md

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.

Always ask: Who will read this, and what do they need to know?

| Creating | New project, no README yet | | Adding | Need to document something new | | Updating | Capabilities changed, content is stale | | Reviewing | Checking if README is still accurate |

À utiliser lors de l'écriture ou de l'amélioration de fichiers README. Tous les README ne sont pas identiques : ils fournissent des modèles et des conseils adaptés à votre public et à votre type de projet. Source : softaworks/agent-toolkit.

Voir l'original