agentleFS
tranhieutttranhieutt/software_development_department/.claude/skills/style-review/SKILL.md

style-review

Skill71 starsChanged 7 months agoMITView on GitHub

Reviews Markdown prose against the pinned agent-style v0.3.5 rules and optionally writes a polished copy beside the source. Use for specs, ADRs, PR bodies, release notes, and technical docs when prose quality or evidence discipline matters.

  • Installs packages

5 other projects use a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

14 rules. 0 are common, 11 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 11

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill for English technical prose where clarity, evidence, and review readability matter:

    line 29
  2. Distinctive:

    Do not use this skill for routine chat, code, generated logs, or prose where the user's requested voice intentionally overrides formal …

    line 38
  3. Distinctive:

    Before any audit, check whether the CLI is available:

    line 43
  4. Distinctive:

    If the command is missing, do not claim style review has run.

    line 49
  5. Distinctive:

    Do not install dependencies unless the user explicitly asks.

    line 56
  6. Very specific:

    Read FILE.md and confirm it is prose that fits this skill's scope.

    line 66
  7. Distinctive:

    Run the deterministic audit:

    line 67
  8. Very specific:

    Add semantic judgment for rules the CLI marks as skipped because they need host-model context: RULE-01, RULE-03, RULE-04, RULE-08, RULE-11, …

    line 73
  9. Distinctive:

    Ask the user before writing any revised copy:

    line 78
  10. Distinctive:

    No new facts, metrics, citations, links, code behavior, or claims.

    line 109
  11. Very specific:

    Write beside the source as FILE.reviewed.md.

    line 113
  12. Distinctive:

    Never mutate or overwrite the source file.

    line 114
  13. Distinctive:

    If RULE-H flags unsupported claims, do not invent evidence.

    line 116
  14. Distinctive:

    When asked "is style-review active?", reply:

    line 130

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Style Review

Opt-in prose review for SDD artifacts using the portable agent-style v0.3.5 skill bundle. This skill is a second-pass review gate, not a global writing mode. It does not edit AGENTS.md, CLAUDE.md, or any source document in place.

Source and Scope

  • Rule pack: .claude/skills/agent-style/references/RULES.md
  • Upstream note: .claude/skills/agent-style/references/UPSTREAM.md
  • Attribution: .claude/skills/agent-style/references/NOTICE.md
  • Detector reference: .claude/skills/agent-style/references/rule-detectors.md
  • Revision prompt: .claude/skills/agent-style/references/revision-prompt.md

Use this skill for English technical prose where clarity, evidence, and review readability matter:

  • Specs and design docs
  • ADRs and decision records
  • PR titles and descriptions
  • Release notes and changelog entries
  • Runbooks, postmortems, and technical documentation

Do not use this skill for routine chat, code, generated logs, or prose where the user's requested voice intentionally overrides formal technical style.

Required CLI Check

Before any audit, check whether the CLI is available:

agent-style --version

If the command is missing, do not claim style review has run. Report this exact fallback:

style-review not run: `agent-style` CLI is not on PATH. Install with `pip install agent-style` or `npm install -g agent-style`, then rerun `/style-review <file>`.

Do not install dependencies unless the user explicitly asks.

Single-File Workflow

Invocation:

/style-review FILE.md
  1. Read FILE.md and confirm it is prose that fits this skill's scope.
  2. Run the deterministic audit:

    agent-style review --audit-only FILE.md
  3. Add semantic judgment for rules the CLI marks as skipped because they need host-model context: RULE-01, RULE-03, RULE-04, RULE-08, RULE-11, RULE-F, and RULE-H. Use the bundled agent-style rules and detector reference as the source of truth.
  4. Report a compact scorecard with per-rule counts and the first few examples.
  5. Ask the user before writing any revised copy:

    Produce a polished draft at FILE.reviewed.md?
  6. On yes, compose the revision using the vendored revision prompt and write only FILE.reviewed.md. Never modify FILE.md.
  7. Re-run the audit on FILE.reviewed.md.
  8. Show before/after scorecard and a diff so the user can merge hunks manually.

A/B Compare Workflow

Invocation:

/style-review BEFORE.md AFTER.md

Run:

agent-style review --mechanical-only --compare BEFORE.md AFTER.md

Report the per-rule delta. Do not ask for polish and do not write files.

Polish Invariants

The polished draft must obey these hard constraints:

  • No new facts, metrics, citations, links, code behavior, or claims.
  • Preserve Markdown structure unless the structure is the violation.
  • Preserve meaning and approximate length budget.
  • Resolve only flagged style issues.
  • Write beside the source as FILE.reviewed.md.
  • Never mutate or overwrite the source file.

If RULE-H flags unsupported claims, do not invent evidence. Keep the claim flagged or ask the user for the missing source.

SDD Integration

  • In REVIEW, use this skill when a prose artifact is important enough that clarity or citation discipline affects review quality.
  • In SHIP, use this skill before final PR bodies, release notes, or docs when the user asks for polish or when the agent claims prose quality.
  • In verification-before-completion, a style-quality claim requires fresh audit evidence from this skill or a clear statement that style review was skipped.

Self-Verification

When asked "is style-review active?", reply:

style-review active: audit 21 rules from agent-style v0.3.5 (deterministic via CLI; semantic via host for RULE-01, 03, 04, 08, 11, F, H); workflow at .claude/skills/style-review/SKILL.md.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.