readme-writer SKILL.md skillA

readme-writer from shimo4228/claude-harness is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add shimo4228/claude-harness/readme-writer@git:20261018.9c2cf31

Pins git:20261018.9c2cf31 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
shimo4228/claude-harness
Path
skills/readme-writer/SKILL.md
Versions recorded
12
Latest version
git:20261018.9c2cf31, committed Oct 18, 2026
First version recorded
Sep 2, 2026
Size
25,302 bytes
Repository stars
3
License
MIT

Write, revise or judge a README, the page someone sees first when opening a repo, and keep the GitHub About in step with it. Use when a README is hard to read or overgrown, needs to follow a code change, or needs only a verdict.

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

# readme-writer — Human-Facing README Skill

人間に向けた README を書く・改善するスキル。`llms-txt-writer` が AI 専用 surface を担うのに対し、
本 skill は **人間 surface の単一正準入口**を担う。

README には 2 種類の読者がいる。人間は上から 1 回読み、合わなければそこで離れる。LLM は、URL を
取得する経路なら畳んだ節も末尾も最後まで読む。だから **見える本文は人間に、LLM 向けの情報は末尾の
畳んだ節(`<details>`)に** 置き分ける。人間には引き算、LLM には足し算を、1 枚の中の位置で両立させる
(較正と出典は `inspiration.md`)。

## モード — 依頼の大きさで選ぶ

| モード | いつ | やること |
|---|---|---|
| **Rewrite** | 新規作成・全面的な作り直し | Workflow の全工程 |
| **Incremental** | コードの変更に README を追従させる(implementation-chain の Doc Sync から来る) | 変わった節だけを書き換え、証拠 JSON → readme-judge(mode: draft。変えた節の名前を渡し、判定器が自分で質問を作る)。概要図は仕組みが変わったときだけ描き直す |
| **Review-only** | 「この README を見て」「判定だけ」「見た目を見て」 | 証拠 JSON(見た目が問いなら描画も)→ readme-judge(mode: draft)。書き換えない |
| **About-only** | description / topics / homepage だけ | Workflow Step 6 だけ(`references/about.md`) |

使わない場面: social-preview 画像の作成(どの skill も作らない。著者が GitHub の設定で置く)、
外部ディレクトリ・awesome-list への掲載申請、graph.jsonld の設計(→ `jsonld-knowledge-graph`)。

---

## 軸は「見える本文 = 人間の注意、畳んだ節 = LLM の情報」

人間の読者の希少資源は注意、LLM の読者の希少資源は渡される情報。同じ文を両方に効かせようとすると、
人間には多すぎ、LLM には足りない文になる。読者ごとに置き場所を分ける。

- **見える本文**: 冒頭の短い段落で何をするものかを言い、残りは読者が使い始めるまでの摩擦を消すことに
  使う(「見える本文」節)
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add shimo4228/claude-harness/readme-writer@sha256:95701418bf19289e

The line at the top of this page pins the label git:20261018.9c2cf31, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_bl3feu6idyzyqqu7.svg)](https://markdownregistry.com/a/art_bl3feu6idyzyqqu7)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 12 versions of this file, between Sep 2, 2026 and Oct 18, 2026, about one every 4 days.

versioncommittedcommitsizeaudit
git:20261018.9c2cf31 latest2026-10-18 9c2cf31 25,302 BA view · diff
git:20261010.b5821aa2026-10-10 b5821aa 25,130 BA view · diff
git:20261008.b63e5f12026-10-08 b63e5f1 24,950 BA view · diff
git:20261008.48777e92026-10-08 48777e9 25,752 BA view · diff
git:20261008.d9c694d2026-10-08 d9c694d 25,226 BA view · diff
git:20261006.26872602026-10-06 2687260 22,432 BA view · diff
git:20261003.f891b772026-10-03 f891b77 20,384 BA view · diff
git:20260927.76ed8952026-09-27 76ed895 20,284 BA view · diff
git:20260925.a3765d22026-09-25 a3765d2 20,026 BA view · diff
git:20260919.f95d2312026-09-19 f95d231 17,930 BA view · diff
git:20260905.002893e2026-09-05 002893e 19,079 BA view · diff
git:20260902.9b5c2402026-09-02 9b5c240 19,099 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (25302 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

GitHub

shimo4228/claude-harness · 3 stars · license MIT · pushed 2026-10-18 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_bl3feu6idyzyqqu7
GET https://markdownregistry.com/api/v1/resolve?ref=shimo4228/claude-harness/readme-writer
GET https://markdownregistry.com/api/v1/blob/95701418bf19289ed2b7db34ee283a46f281c6d63c1e6f9fbafc029442ae2035

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 shimo4228/claude-harness

widen-depth SKILL.md skill
shimo4228/claude-harness · docs/evals/SKILL.md · 依頼を大きな版でなく深い版に書き直す。一流がやること・生の素材・方法と道具・外部の判定を引き出す。
git:20261018.9c2cf31 · audit A · 3 stars
llms-full.txt llms.txt file
shimo4228/claude-harness · llms-full.txt
git:20261010.7fd1204 · audit A · 3 stars
llms.txt llms.txt file
shimo4228/claude-harness · llms.txt
git:20261010.0028cd9 · audit A · 3 stars
adr-writer SKILL.md skill
shimo4228/claude-harness · skills/adr-writer/SKILL.md · Record a design decision as an ADR in the repo's docs/adr/, or decide whether it clears the filing bar or belongs in a…
git:20261010.b5821aa · audit A · 3 stars
agent-send SKILL.md skill
shimo4228/claude-harness · skills/agent-send/SKILL.md · Send a prompt to an agent running in a Herdr pane and confirm it landed, or wait until its work is done. Use when…
git:20261010.b5821aa · audit A · 3 stars
agent-stocktake SKILL.md skill
shimo4228/claude-harness · skills/agent-stocktake/SKILL.md · Audit the ~/.claude/agents definitions and give each a verdict.
v1.0 · audit A · 3 stars
author-calibrated-eval SKILL.md skill
shimo4228/claude-harness · skills/author-calibrated-eval/SKILL.md · Polish LLM-written prose with the author's own reading as ground truth.
git:20261008.b63e5f1 · audit A · 3 stars
authorship-strategy SKILL.md skill
shimo4228/claude-harness · skills/authorship-strategy/SKILL.md · Evaluate a concrete proposal against the author's authorship strategy, or apply and explain the existing judgment…
git:20261008.b63e5f1 · audit A · 3 stars
collect-context SKILL.md skill
shimo4228/claude-harness · skills/collect-context/SKILL.md · Collect sourced material into an evidence dossier before writing an article or essay. Use when gathering material for a…
git:20261008.b63e5f1 · audit A · 3 stars
context-sync SKILL.md skill
shimo4228/claude-harness · skills/context-sync/SKILL.md · Audit a repo's context documents (CLAUDE.md, ADRs, README, graph.jsonld) for role overlap and staleness against the…
git:20261011.dd38b78 · audit A · 3 stars
generation-audit SKILL.md skill
shimo4228/claude-harness · skills/generation-audit/SKILL.md · Audit the harness when a new Claude model takes a role (judge, build or everyday).
v2.0 · audit A · 3 stars
harness-boundary SKILL.md skill
shimo4228/claude-harness · skills/harness-boundary/SKILL.md · Design lens: which layer a harness mechanism belongs in, and whether it outlives the next model or runtime.
git:20261008.b63e5f1 · audit A · 3 stars

Every file in shimo4228/claude-harness

Other files named readme-writer

readme-writer SKILL.md skill
wst2002/claude-code-skills · skills/readme-writer/SKILL.md · Use when writing a README, improving or rewriting an existing README.md, documenting a project for new users or…
git:20261016.55bd98a · audit A · 3 stars

Browse by kind, by grade A, or by owner.