readme-writing

readme-writing is a skill for Claude Code from KhaledSaeed18/dotclaude. It costs 99 tokens per session (911 once invoked), scanned A, original, MIT.

A README-writing guide for creating or reorganising a project's main introduction and setup instructions. It checks the documentation against the repository so the quick start reflects the actual code.

In plain words
What is it for?
It helps document a project's purpose, installation, first working example, configuration, usage, and contribution steps.
Why use it?
It prevents new users from getting stuck with outdated commands, missing prerequisites, or instructions that the project does not support.

Skill for Claude Code

Written for Claude Code: argument-hint in frontmatter.

Part of the docs plugin — 4 skills shipped together

Good fit It helps document a project's purpose, installation, first working example, configuration, usage, and contribution steps.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/khaledsaeed18/dotclaude/readme-writing
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add KhaledSaeed18/dotclaude --skill readme-writing
Clone the repo
git clone --depth 1 https://github.com/KhaledSaeed18/dotclaude

Made for: Claude Code.

Or install docs, the plugin that ships this one along with the rest of its 4 skills.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme-writing

README.md
[![agentmods](https://agentmods.dev/badge/skills/khaledsaeed18/dotclaude/readme-writing/github.svg)](https://agentmods.dev/skills/khaledsaeed18/dotclaude/readme-writing)
Your own site
<a href="https://agentmods.dev/skills/khaledsaeed18/dotclaude/readme-writing"><img src="https://agentmods.dev/badge/skills/khaledsaeed18/dotclaude/readme-writing/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme-writing

Your own site · 80×15
<a href="https://agentmods.dev/skills/khaledsaeed18/dotclaude/readme-writing"><img src="https://agentmods.dev/badge/skills/khaledsaeed18/dotclaude/readme-writing.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 99 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 911 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00099 $0.00911
Opus 5.5 $0.00040 $0.00364
Sonnet 5.5 $0.00020 $0.00182
Haiku 4.5 $0.00010 $0.00091

Measured 25d ago against content hash 665863b1b5ef, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

readme-writing scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 25d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude-plugin/plugins/docs/skills/readme-writing/SKILL.md · 72 lines

How it starts

The opening of the file, as written. The whole thing — 72 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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

# 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).
The minimal commands, copy-pasteable, that produce a visible result. Nothing optional here.
What the user should see when it worked.

## Usage

The three to five most common tasks, each: one sentence, one code block, one sentence on the result. Link to full reference docs for the rest.

## Configuration

Table: option, env var or flag, default, what it does. Only options a user will actually set.

## How it works (optional)

Three to six sentences or a diagram, for the reader deciding whether to trust or extend it.

## Development

Clone, install, test, lint, in four commands. Link to CONTRIBUTING for the rest.

## License

Omit a section rather than fill it with filler. A library README leads with the API example; a CLI README leads with the command; a service README leads with the deploy or run command.

Rules

  • Verify every command by running it (or by reading the script it invokes when running is not possible) and say the runtime version it was verified with.
  • Match the manifest: the install command uses the real package name and manager; scripts named in the README exist in the manifest.
  • No aspirational features. If it is planned, it goes in a roadmap section or an issue, not in Usage.
  • Sentence case headings, short paragraphs, no em dashes, no "simply", no "just".
  • Keep the top stable: the first screen changes rarely; volatile detail (options, versions) lives lower or in generated sections between markers so a script can update it.
  • Badges are signals, not decoration: a red CI badge on the README is honest; ten badges are noise.
  • Link, do not duplicate: the changelog, the API reference, and the contribution guide each live in one place.
  • Run humanize on the prose before returning.

Read the full file on GitHub · 72 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 25d ago First seen · 72 lines · 99 tokens per session scan A 665863b1b5ef

Subscribe to this mod's changes

readme-writing is a skill published in the GitHub repository KhaledSaeed18/dotclaude (5 stars, last pushed 2d ago), licensed MIT. It adds 99 tokens to every session and 911 once invoked, about $0.0004 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-22.

Related

Other skills, from other repositories

analytics-strategy

Design measurement frameworks including event taxonomy, KPI hierarchy, dashboard architecture, attribution models, and analytics implementation strategy. Use this skill whenever the user wants to plan analytics, design dashboards, build event taxonomies, define KPIs, set up tracking, or audit existing measurement.…

rampstackco/claude-skills · 126 tokens

content-strategy

Develop a content strategy covering editorial positioning, content pillars, formats, calendar, governance, and topical authority planning. Use this skill whenever the user wants to plan a content program, define content pillars, build an editorial calendar, structure topic clusters, set up content governance, or align…

rampstackco/claude-skills · 120 tokens

agb-begriff-vorformuliert-305

Für AGB Begriff Vorformuliert 305: ordnet Norm, Beweislast und Gegenargument; Ergebnis: Prüfprodukt mit Risiko und nächstem Schritt. Fachgebiet: AGB-Recht-Prüfer. Route: agb-begriff-vorformuliert-305.

Klotzkette/claude-fuer-deutsches-recht · 68 tokens

agb-rechtswahl-schweizer-recht-rom-i

Für AGB Rechtswahl Schweizer Recht Rom I: ordnet Norm, Beweislast und Gegenargument; Ergebnis: Prüfprodukt mit Risiko und nächstem Schritt. Fachgebiet: AGB-Recht-Prüfer. Route: agb-rechtswahl-schweizer-recht-rom-i.

Klotzkette/claude-fuer-deutsches-recht · 69 tokens

review-work

Post-implementation gate review: run manual QA on the real surface yourself, then launch ONE gate reviewer (never a panel) to audit goal, constraints, code quality, security, missed context, and QA evidence. Use before a PR handoff or when the user explicitly asks to review completed work.

code-yeongyu/oh-my-openagent · 63 tokens

haftungsdeckel-fuer-daten-und-modelldienste-pruefen

Bewertet Haftungshöchstbeträge bei Datenverlust, fehlerhaften Modellausgaben und Ausfällen digitaler Dienste anhand konkreter Schadensszenarien. Liefert eine Entscheidungsvorlage mit Risikobeträgen, Ausnahmen und Freigabebedarf.

Klotzkette/claude-fuer-deutsches-recht · 77 tokens