Beads Documentation Style Guide
gastownhall/beads
Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.
Reviews the user-facing docs — README.md and the user guides under docs/README.md "Using it" — by running them past subagent reviewers role-playing fixed personas: a first-time visitor, a user…
Install Docs Review
$ npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install antoinecellerier/speaker-tuning-to-easyeffects docs-review --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/antoinecellerier/speaker-tuning-to-easyeffects.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/docs-review .claude/skills/docs-review && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "docs-review" agent skill from https://github.com/antoinecellerier/speaker-tuning-to-easyeffects/tree/master/.claude/skills/docs-review into .claude/skills/docs-review/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-review", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/antoinecellerier/speaker-tuning-to-easyeffects/tree/master/.claude/skills/docs-reviewType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install antoinecellerier/speaker-tuning-to-easyeffects docs-review --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/antoinecellerier/speaker-tuning-to-easyeffects.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills/docs-review .agents/skills/docs-review && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "docs-review" agent skill from https://github.com/antoinecellerier/speaker-tuning-to-easyeffects/tree/master/.claude/skills/docs-review into .agents/skills/docs-review/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-review", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install antoinecellerier/speaker-tuning-to-easyeffects docs-review --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/antoinecellerier/speaker-tuning-to-easyeffects.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills/docs-review .cursor/skills/docs-review && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "docs-review" agent skill from https://github.com/antoinecellerier/speaker-tuning-to-easyeffects/tree/master/.claude/skills/docs-review into .cursor/skills/docs-review/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-review", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/antoinecellerier/speaker-tuning-to-easyeffects.git --path .claude/skills/docs-review--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install antoinecellerier/speaker-tuning-to-easyeffects docs-review --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/antoinecellerier/speaker-tuning-to-easyeffects.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills/docs-review .gemini/skills/docs-review && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "docs-review" agent skill from https://github.com/antoinecellerier/speaker-tuning-to-easyeffects/tree/master/.claude/skills/docs-review into .gemini/skills/docs-review/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-review", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install antoinecellerier/speaker-tuning-to-easyeffects docs-reviewInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/antoinecellerier/speaker-tuning-to-easyeffects.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills/docs-review .github/skills/docs-review && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "docs-review" agent skill from https://github.com/antoinecellerier/speaker-tuning-to-easyeffects/tree/master/.claude/skills/docs-review into .github/skills/docs-review/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-review", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install antoinecellerier/speaker-tuning-to-easyeffects docs-review --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/antoinecellerier/speaker-tuning-to-easyeffects.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills/docs-review .opencode/skills/docs-review && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "docs-review" agent skill from https://github.com/antoinecellerier/speaker-tuning-to-easyeffects/tree/master/.claude/skills/docs-review into .opencode/skills/docs-review/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-review", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
docs-review- GitHub stars
- 143
- Token cost
- ~1.5k tokens
- SKILL.md length
- 383 words
- Files
- 1
- Skills in repo
- 7
- Repo updated
- First seen
- Licence
- MIT
At a glance
Reviews the user-facing docs — README.md and the user guides under docs/README.md "Using it" — by running them past subagent reviewers role-playing fixed personas: a first-time visitor, a user…
- Works in 3 steps: Give the reviewer the files and nothing… → Dispatch the reviewers → Triage before reporting
- Asks for a persona review
- SKILL.md covers 1. Give the reviewer the files…, 2. Dispatch the reviewers and 3. Triage before reporting
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Docs Review is an agent skill from antoinecellerier/speaker-tuning-to-easyeffects. Reviews the user-facing docs — README.md and the user guides under docs/README.md "Using it" — by running them past subagent reviewers role-playing fixed personas: a first-time visitor, a user troubleshooting a symptom, and a PipeWire-only user. Reports severity-ranked findings after triage. Use after changing README or a user guide, before a release, and whenever the user asks for a "persona review", to "check the docs read well", or whether a newcomer can get from zero to working sound. Complements…
Its SKILL.md is about 1.5k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Writing & Content, covering Technical writing, Technical documentation and Subagents. The repository describes itself as: Convert OEM Dolby Atmos speaker tuning data to EasyEffects presets or PipeWire filter-chains for Linux. The licence is MIT.
When your agent uses it
- Asks for a persona review
- Check the docs read well
- Whether a newcomer can get from zero to working sound
Example prompts
- “Using it”
- “persona review”
- “check the docs read well”
- “/docs-review”
Workflow steps
3 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit 3000a2a. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Docs Review loads about 1.5k tokens when it runs. Until then it costs about 169 tokens; SKILL.md has 383 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from antoinecellerier/speaker-tuning-to-easyeffects at commit 3000a2a, republished under its MIT licence (© antoinecellerier). 383 words, ~1,459 tokens.
Download SKILL.mdSave it as
.claude/skills/docs-review/SKILL.md (or your agent's skills folder).- name
- docs-review
- description
- Reviews the user-facing docs — README.md and the user guides under docs/README.md "Using it" — by running them past subagent reviewers role-playing fixed personas: a first-time visitor, a user troubleshooting a symptom, and a PipeWire-only user. Reports severity-ranked findings after triage. Use after changing README or a user guide, before a release, and whenever the user asks for a "persona review", to "check the docs read well", or whether a newcomer can get from zero to working sound. Complements /user-review, which covers the scripts' terminal output. The doc tests trap broken links and drift, and this catches a reader who gets lost, stuck or misled.
docs-review
tests/test_doc_refs.py proves every link lands and the sync tests prove the
option lists match argparse. Neither proves a reader can find the fix for
their symptom, or would not give up at step 3. Only a reader who doesn't
already know the answer finds those.
The personas and scenarios below are fixed on purpose. Re-running the same ones after each docs change is what shows drift. Change them only when the product changes: a new entry point, a new common symptom, a dropped route.
Re-run after fixing. A fix to a landing page can strand a reader somewhere else.
1. Give the reviewer the files and nothing else
Each prompt names the entry file and the directory it may follow links into.
Do not summarise the docs, define a term, or say which section answers which
symptom. A user has none of that, and every hint turns a finding into a
pass. The one piece of context is how to read the files: as rendered GitHub
markdown, where <!-- --> comments and <a id> tags are invisible.
Reviewers are read-only: they read files and run nothing.
2. Dispatch the reviewers
Dispatch all three in parallel with the prompts below verbatim, filling in
the absolute repo path for <REPO>. Run them at model: sonnet: a less
capable reader is a more faithful proxy for a newcomer, and cheaper.
Shared block (append to every prompt)
Treat the files as rendered GitHub markdown: `<!-- -->` comments and `<a id>`
tags are invisible. Follow only links you would actually click, within
<REPO>/README.md and <REPO>/docs/. READ-ONLY: only read files; do not edit or
run anything.
REPORT FORMAT, under 450 words. First, one line: would you keep going with
this tool? Then ONE list, worst first. For each finding: SEVERITY, the quoted
sentence with file:line, what's wrong from your point of view, and your fix in
one sentence.
- CRITICAL — no route forward, a wrong or unsafe instruction, a contradiction,
or a link whose target doesn't deliver what its text promises
- HIGH — you'd act wrongly, or couldn't act without guessing
- MEDIUM — you'd get there at a cost: a detour, jargon, a buried step
- LOW — polish, including style that differs between pages
Say explicitly if a severity level is empty. No praise, no filler findings.Show full SKILL.md (151 more words)Show less
Reviewer A: first-time visitor
Role-play a Linux laptop user who just found this project via a Reddit thread
titled "Finally, my ThinkPad speakers sound like on Windows". You're
comfortable with a terminal, have never used git, and have never heard of
EasyEffects presets, DAX3 or PipeWire filter-chains. Your laptop: a Lenovo
Yoga, Linux only (you wiped Windows), Ubuntu.
Read <REPO>/README.md first, then follow the links you'd click. Cover: the
first screen (what it is, whether it's for you); the exact steps from zero to
working sound, flagging every stuck point; anything that scares you off; and
dangling "below/above" references or naming that differs between pages.Reviewer B: troubleshooter
Role-play a user who installed this tool a week ago with a Flatpak
EasyEffects and now has a problem. Run four scenarios, each from where you'd
arrive:
A. You googled "easyeffects dolby preset no difference" and landed directly on
<REPO>/docs/troubleshooting.md.
B. From <REPO>/README.md: music sounds "crushed and pumpy on loud parts".
C. From <REPO>/README.md: after switching to Bluetooth headphones they sound
over-processed.
D. From <REPO>/README.md: you updated to a new release and re-ran the script,
but hear no change.
For each: the path you took (file → section), hops to an actionable fix, and
whether the fix really addresses the symptom.Reviewer C: PipeWire-only user
Role-play a Fedora user on a Lenovo laptop with its Windows partition mounted,
who runs a minimal desktop and won't install EasyEffects or any GUI audio app.
You want the tuning applied at boot and to forget about it.
Read <REPO>/README.md first, then follow the links you'd click. Cover: whether
you can tell early that a no-EasyEffects route exists; the exact steps to
working sound; how you'd confirm it's active and how you'd remove it; and
anything that tells you to install or run EasyEffects after all.3. Triage before reporting
Reviewer output is evidence, not instruction.
- Verify each finding against the docs and the code. Some are misreadings. A link complaint is checked by opening the target section.
- Weight agreement: two reviewers reaching the same finding independently is the strongest signal.
- Drop findings that ask for content the docs deliberately leave to another page, when the link to it is there and says so.
- Before adopting a fix, name the doc section, code path or measurement that
makes the new sentence true, because no reviewer here checks truth:
.claude/rules/claims.md"What each claim rests on", and for a rewrite its "Rewriting existing text" gates.
Report the triaged list, ranked, each finding keeping a severity label (the reviewer's, or yours where triage moved it), and let the user choose what to fix. Name what you dropped and why.
© antoinecellerier, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .claude/skills/docs-review of antoinecellerier/speaker-tuning-to-easyeffects.
Open the folder on GitHubat commit 3000a2a
Compare with similar skills
Docs Review next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Docs Review this skillantoinecellerier/speaker-tuning-to-easyeffects | 143 | — | ~1.5k | Automated safety check: Pass | MIT | |
| Beads Documentation Style Guidegastownhall/beads | 28k | — | ~3.2k | Automated safety check: Pass | MIT | |
| Technical Writing Standardcursor/plugins | 10k | 10 repos | ~2.4k | Automated safety check: Pass | None | |
| Heym Documentation Articlesheymrun/heym | 1.4k | — | ~780 | Automated safety check: Pass | Custom licence | |
| Developer Docs Technical Writervercel-labs/github-tools | 131 | — | ~3.9k | Automated safety check: Pass | MIT | |
| Aholo Viewer Docsmanycoretech/aholo-viewer | 1.1k | — | ~341 | Automated safety check: Pass | MIT |
Similar skills
- Official
Technical Writing Standard
cursor/plugins
Applies four layers of technical-writing rules to docs, RFCs, readmes, PR descriptions and commit messages so a tired engineer follows them on the first read.
Heym Documentation Articles
heymrun/heym
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.
- Official
Developer Docs Technical Writer
vercel-labs/github-tools
Writes, reviews and edits developer documentation for SDKs, libraries and frameworks, from getting-started guides and API references to migration guides.
Aholo Viewer Docs
manycoretech/aholo-viewer
Guides writing and maintaining Aholo Viewer documentation: README, AGENTS.md, architecture notes, bilingual manual pages and AI collaboration guides.
Diataxis
WebMCP-org/npm-packages
Write technical documentation following the Diataxis framework by Daniele Procida.
More from antoinecellerier/speaker-tuning-to-easyeffects
Copy Audit
antoinecellerier/speaker-tuning-to-easyeffects
Audits the user-facing terminal copy changed over a git range for factual truth rather than readability, by fanning out reviewers partitioned by evidence source and triaging what survives.
Claude Md Audit
antoinecellerier/speaker-tuning-to-easyeffects
Audits the instruction files (CLAUDE.md, .claude/rules, .claude/skills, tools/measuredax/CLAUDEWINDOWS.md) for accuracy and bloat against .claude/rules/instructions.md, and proposes a concrete edit…
Issue Replies
antoinecellerier/speaker-tuning-to-easyeffects
Guides triaging GitHub issues and drafting or posting replies in this repo.
Kernel Watch Triage
antoinecellerier/speaker-tuning-to-easyeffects
Guides triaging a kernel-sound-watch hit comment on the "Kernel sound-tree watch" issue (40) — the weekly workflow's per-tag report of .github/kernel-watchlist.txt grep hits against a new…
User Review
antoinecellerier/speaker-tuning-to-easyeffects
Reviews the scripts' user-facing terminal output by running it past subagent reviewers role-playing a first-time user, then reports severity-ranked findings.
Audio Validate
antoinecellerier/speaker-tuning-to-easyeffects
Validates a change to the audio output path against measured on-device ground truth.
Related
Questions about Docs Review
What does Docs Review do?
Reviews the user-facing docs — README.md and the user guides under docs/README.md "Using it" — by running them past subagent reviewers role-playing fixed personas: a first-time visitor, a user…. Docs Review is an agent skill from antoinecellerier/speaker-tuning-to-easyeffects.md "Using it" — by running them past subagent reviewers role-playing fixed personas: a first-time visitor, a user troubleshooting a symptom, and a PipeWire-only user.
When should I use Docs Review?
Docs Review fits situations like: asks for a persona review; check the docs read well; whether a newcomer can get from zero to working sound.
How do I install Docs Review in Claude Code?
Run `npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a claude-code`. Or copy the skill folder (.claude/skills/docs-review in antoinecellerier/speaker-tuning-to-easyeffects) into .claude/skills/docs-review in your project. Claude Code loads it when a task matches its description.
How do I install Docs Review in Codex?
Run `npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a codex`. Or copy the skill folder (.claude/skills/docs-review in antoinecellerier/speaker-tuning-to-easyeffects) into .agents/skills/docs-review in your project. Codex loads it when a task matches its description.
Can I use Docs Review in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add antoinecellerier/speaker-tuning-to-easyeffects --skill docs-review -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-review, .gemini/skills/docs-review, .github/skills/docs-review and .opencode/skills/docs-review in your project.
What does Docs Review need to run?
SKILL.md names no scripts, command-line tools or credentials: Docs Review is instructions for the agent only.
Does Docs Review access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Docs Review safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Docs Review use?
Docs Review is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Docs Review use?
About 1.5k tokens (SKILL.md is roughly 5.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Docs Review?
Skills that share tags, products or a category with Docs Review: Beads Documentation Style Guide (gastownhall/beads, 28k stars), Technical Writing Standard (cursor/plugins, 10k stars), Heym Documentation Articles (heymrun/heym, 1.4k stars) and Developer Docs Technical Writer (vercel-labs/github-tools, 131 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Docs Review?
antoinecellerier (a GitHub user) maintains it in antoinecellerier/speaker-tuning-to-easyeffects, which has 143 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on October 8, 2026.
Source: antoinecellerier/speaker-tuning-to-easyeffects on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.