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 |

Zum Schreiben oder Verbessern von README-Dateien verwenden. Nicht alle READMEs sind gleich – sie bieten Vorlagen und Anleitungen, die auf Ihre Zielgruppe und Ihren Projekttyp abgestimmt sind. Quelle: softaworks/agent-toolkit.

Original anzeigen