skilld
All skills
davila7 avatar

/crafting-effective-readmes

@1c194fd
by Daniel Aviladavila7/claude-code-templates32k stars
3,662

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

Ask your Agent

Use this Skill: https://skilld.dev/gh/davila7/claude-code-templates/crafting-effective-readmes

This session only. Nothing lands on disk.

style-guide.md

≈109 tokens on demand. Your agent reads this file only when SKILL.md points to it.

README Style Guide

Common Mistakes

  • No install steps - Never assume setup is obvious
  • No examples - Show, don't just tell
  • Wall of text - Use headers, tables, lists
  • Stale content - Add "last reviewed" date
  • Generic tone - Write for YOUR audience

Prose Quality

For general writing advice — clear prose, Strunk's rules, and AI patterns to avoid — use the writing-clearly-and-concisely skill.

Source: SKILL.md on GitHub

Third-party checks

1 warning12d4 checks · Risk SAFE
  • Gen Agent Trust Hub12d

    The skill provides comprehensive templates and guidance for writing, updating, and reviewing project README files tailored to different project types (Open Source, Personal, Internal, Config). It is purely instructional and does not contain any malicious code, dangerous commands, or data exfiltration patterns.

  • Socket12d

    No alerts

  • Snyk12d

    Risk: LOW · No issues

  • Runlayer7mo

    14/14 files flagged

Provenance

Signed by skilld at 1c194fd. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 14 hours ago.

Activeupdated 8 months ago

README badge

README badge for davila7/claude-code-templates/crafting-effective-readmes