readme-writing SKILL.md skillA
readme-writing from khaledsaeed18/dotclaude is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add khaledsaeed18/dotclaude/readme-writing@git:20260921.b628018Pins git:20260921.b628018 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- khaledsaeed18/dotclaude
- Path
.claude-plugin/plugins/docs/skills/readme-writing/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260921.b628018, committed Sep 21, 2026
- Size
- 4,059 bytes
- Repository stars
- 5
- License
- MIT
Write or restructure a README that gets a reader from landing to first success in minutes: a one-line purpose, a working quick start verified against the actual code, then usage, configuration, and contribution pointers in the order a new user needs them, with nothing the code contradicts. Reads the repository first and never documents behaviour it has not confirmed. Use when a project has no README, when the README has drifted from the code, or before publishing a package or repository.
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
A README is the front door. Its first screen must answer three questions: what is this, is it for me, how do I try it. Everything after that is in order of how soon a new user needs it. The README is verified against the code, not written from memory of the code. ## Read before writing 1. The manifest (`package.json`, `pyproject.toml`, `Cargo.toml`, `go.mod`): name, version, entry points, scripts, dependencies, engines. 2. The entry point and the public surface: CLI flags (`--help` output if it runs), exported functions, routes, config schema. 3. Existing docs, `CONTRIBUTING`, `LICENSE`, CI config, examples directory, tests (they show real usage). 4. Run the quick start you intend to document. If it does not work, the README says what actually works. ## Structure ```markdown # name One sentence: what it does and for whom. (Badges on the next line, at most four: CI, version, license, one more.) Two or three sentences: the problem it solves and the one thing that distinguishes it. Optional: a screenshot or a 10-line example that shows the payoff. ## Quick start Prerequisites in one line (runtime version, accounts, keys). …
Read the whole file at its exact version.
How to install
mdr add khaledsaeed18/dotclaude/readme-writing@sha256:665863b1b5efe31dThe line at the top of this page pins the label git:20260921.b628018, 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_7dpdew6okkgqezv3)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Sep 21, 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 (4059 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
khaledsaeed18/dotclaude · 5 stars · license MIT · pushed 2026-11-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_7dpdew6okkgqezv3 GET https://markdownregistry.com/api/v1/resolve?ref=khaledsaeed18/dotclaude/readme-writing GET https://markdownregistry.com/api/v1/blob/665863b1b5efe31d906f10b46b00efca9a47e9485b2ad346fe5ad01b90bbe670
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 khaledsaeed18/dotclaude
Every file in khaledsaeed18/dotclaude