Cross-Cutting

/precise-readme

Precision-mode pass on the README + GH Pages docs corpus. Cuts filler, dedups README ↔ docs/ overlap, archives originals under `docs/v1/` with cross-banners. The fix for the recurring 'the README is too dense' complaint.

Hat Stage Upstream gate Output
Cross-cutting Docs maintenance None In-place edits to README.md + docs/*.md + docs/v1/* mirror

When to use

Not for: typo fixes, single-section rewrites, doc additions. Use a normal edit.

Prerequisites

Run

/precise-readme

What it does

  1. Scope: enumerates README.md + every docs/*.md, records baseline word + line counts.
  2. Grill: invokes /grill-me quick for scope, audience, sacred bits, aggression, dedup rule. Defaults are sensible; you can pre-accept them.
  3. Rewrite: applies precision-mode rules. Lead with the answer, no filler, structure > prose, no em-dashes outside code blocks, no hype words.
  4. Sacred preservation: every fenced code block, every command/alias table, every URL, every mermaid diagram, every per-skill catalogue row is preserved verbatim.
  5. Dedup: when README = pointer is chosen (default), long-form duplicates between README and docs/<page>.md collapse into one-paragraph pointers; docs/ stays the source of truth.
  6. V1 archive: mirrors every in-scope file to docs/v1/<basename> with a banner pointing forward to the V2 counterpart. Every V2 page gets a one-line backlink to V1. Engineers who liked the dense version keep a permanent home.
  7. Verify: runs scripts/check-docs-links.sh, em-dash sweep outside code blocks, internal link resolution check.
  8. Report: prints per-file + total word + line delta. Hands off to the user; does not commit or push.

Default presets

If you want to skip the grill:

Output contract

Reference run

Skill was distilled from a session that ran the pass on amit-t/ai-workbench:

File Words (old → new) Δ
README.md 2892 → 956 -67%
docs/architecture.md 1091 → 961 -12%
docs/faq.md 557 → 403 -28%
docs/getting-started.md 270 → 215 -20%
docs/index.md 261 → 249 -5%
docs/lifecycle.md 434 → 391 -10%
docs/onboarding-wsl.md 264 → 228 -14%
docs/ralph.md 685 → 552 -19%
docs/skills.md 568 → 553 -3%
docs/versioning.md 570 → 430 -25%
Total 7592 → 4938 -35%

Pages with small deltas (skills, architecture) are dominated by sacred content (tables, code blocks). Real prose density gain is higher than the headline number.

Do not

See also