docs

Solid

Improves and simplifies this repo's documentation without losing a fact — finds contradictions between surfaces, duplicated facts, sentences no longer true of the binary, pages nobody links, and prose a reader cannot act on; proposes the smaller true version through the second-family door. Use "simplify the docs", "is the README still true", "docs review", "too long", "where should this go".

Code & Development 63 stars 0 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 87/100

Stars 20%
60
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

Target: $ARGUMENTS (empty = the published set: `README.md`, `docs/README.md`, `FEATURES.md`, `ROADMAP.md`, `docs/*.md`, `site/llms.txt`, `PRIVACY.md`). ## Where a fact belongs (one fact, one place) | Kind of fact | Home | Everything else | |---|---|---| | what the binary can do, counts, flags | `docs/reference.json` via `make docs`; `data-claim` spans | links, never restates | | what exists and since when | `FEATURES.md` | — | | what shipped per release | `CHANGELOG.md` | — | | what might be built | `BACKLOG.md` (ids) under `ROADMAP.md` (direction) | — | | a figure that was wrong | `docs/corrections.md` | the changelog line links it | | how to extend | `docs/extending.md` + one page per surface | — | | contributor rules | `CONTRIBUTING.md` | `AGENTS.md` compresses, never contradicts | | maintainer operations | `RELEASING.md`, `docs/site.md`, `docs/operations.md` | — | ## The pass 1. **Mechanical first**: `make docs && make test` (published-or-excused, links, claims, ADR index, flags), then `surface-auditor` for the judgement half — the stale sentence, the closed caveat still printed, the roadmap wording about something that shipped. 2. **Duplicates and contradictions**: for each fact stated twice, name the home and cut the copy to a link. A sentence true in one file and false in another is a defect, not style. 3. **Readability**: sentences a reader can act on, one idea each; the narrative behind a rule stays (it is why a reader trusts a figure) but lives once,...

Details

Author
assaio
Repository
assaio/assaio
Created
2 months ago
Last Updated
today
Language
Go
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Solid

write-docs

Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.

46 Updated yesterday
dzhng
Data & Documents Listed

docs

Create or refresh this repo's README.md, CLAUDE.md and mkdocs.yml, detecting project metadata from git and the manifest. Preserves hand-written prose. Writes files only — no commit, no branch, no PR.

4 Updated yesterday
Jebel-Quant
Data & Documents Listed

docs-structure

Check, build and fill a repository's Markdown documentation from what the repository actually contains. Read-only by default - reports which docs a repo needs (derived from its code, configs and history, not a fixed list), which existing doc covers each concern whatever its file name, and what is unreachable, oversized, dead-linked or cited by line number. On request it lays down skeleton docs for uncovered concerns and drafts them sentence by sentence from repo evidence with the source in brackets, marked for review. Use for docs layout, a docs index, orphaned or oversized docs, splitting a big doc, owner lines, setting up docs for a new repo, or drafting an architecture, deployment, data-model or API doc from the repo. Not for whether existing prose is still true or has missed a code change (use docs-sync-audit) and not for source-code structure (use repo-health-audit).

1 Updated 1 weeks ago
specialone0007