crafting-effective-readmes SKILL.md skillA
crafting-effective-readmes from j-star-films-studios/vibecode-protocol-suite is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add j-star-films-studios/vibecode-protocol-suite/crafting-effective-readmes@git:20260820.4dbe9e4Pins git:20260820.4dbe9e4 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- j-star-films-studios/vibecode-protocol-suite
- Path
assets/.agent/skills/agent-engineering/crafting-effective-readmes/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260820.4dbe9e4, committed Aug 20, 2026
- Size
- 2,676 bytes
- Repository stars
- 26
- License
- ISC
Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Crafting Effective READMEs ## Overview 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? ## Process ### Step 1: Identify the Task **Ask:** "What README task are you working on?" | Task | When | |------|------| | **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 | ### Step 2: Task-Specific Questions **Creating initial README:** 1. What type of project? (see Project Types below) 2. What problem does this solve in one sentence? 3. What's the quickest path to "it works"? 4. Anything notable to highlight? **Adding a section:** 1. What needs documenting? 2. Where should it go in the existing structure? 3. Who needs this info most? **Updating existing content:** 1. What changed? 2. Read current README, identify stale sections 3. Propose specific edits **Reviewing/refreshing:** 1. Read current README …
Read the whole file at its exact version.
How to install
mdr add j-star-films-studios/vibecode-protocol-suite/crafting-effective-readmes@sha256:638b271fdc148249The line at the top of this page pins the label git:20260820.4dbe9e4, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_qniyqsv2rec33ivg)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Aug 20, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (2676 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
j-star-films-studios/vibecode-protocol-suite · 26 stars · license ISC · pushed 2026-10-17 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_qniyqsv2rec33ivg GET https://markdownregistry.com/api/v1/resolve?ref=j-star-films-studios/vibecode-protocol-suite/crafting-effective-readmes GET https://markdownregistry.com/api/v1/blob/638b271fdc148249ed8896dbdcf15f9067a8d64ba7d2d82ec3e86f8d82831b51
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from j-star-films-studios/vibecode-protocol-suite
Every file in j-star-films-studios/vibecode-protocol-suite