CLAUDE.md

1# CLAUDE.md
2 
3This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4 
5## What this is
6 
7A single-file writing skill (`SKILL.md`) that audits and rewrites content to remove AI writing patterns. The skill is a markdown file consumed by AI coding assistants; the repository also includes a dependency-free deterministic detector and test suite.
8 
9## Repository structure
10 
11- `SKILL.md` — the skill itself. This is the product. All rules, tiers, profiles, and output format live here.
12- `README.md` — public-facing docs, installation instructions, pattern reference table, full before/after example.
13- `CHANGELOG.md` — version history with what changed and why.
14 
15## How to make changes
16 
17Edit `SKILL.md` directly. When making changes:
18 
19- Bump the version in the SKILL.md frontmatter (`version: X.Y.Z`)
20- Run `bash scripts/sync-plugin-skill.sh`. Root SKILL.md is the source of truth; the plugin's bundled copy and `plugin.json`'s version are generated from it, and CI fails on a mismatch. Bumping the frontmatter without this step fails the `check` job with `version mismatch: SKILL.md=X plugin.json=Y`.
21- Run `npm test` to exercise the detector, category contract, validator, corpus helpers, and style checks.
22- Add a dated entry to CHANGELOG.md
23- Update README.md if the change affects installation, usage, feature list, or pattern count
24- The pattern count lives in **one** place — the README "61 pattern categories" bullet — and is derived from SKILL.md's detection `###` entries. Don't restate it elsewhere; CI (`scripts/check-pattern-count.sh`) fails the build if the README number drifts from SKILL.md, so just add the new `###` entry and bump the README bullet.
25 
26## Architecture of the skill
27 
28The skill has three modes (`rewrite` default, `detect` flag-only, `edit` in-place) and processes text through this pipeline:
29 
301. **Context profile detection** — auto-detects or accepts a profile hint (linkedin, blog, technical-blog, investor-email, docs, casual) that adjusts rule strictness via the tolerance matrix
312. **Pattern matching** — detection categories across content, language, structure, communication, and meta patterns (see SKILL.md for the catalog; the count is in the README bullet)
323. **Vocabulary flagging** — 3-tier system: Tier 1 (always flag), Tier 2 (flag in clusters), Tier 3 (flag at high density)
334. **Severity classification** — P0 (credibility killers), P1 (obvious AI smell), P2 (stylistic polish)
345. **Output** — rewrite mode: 4 sections including a second-pass audit; detect mode: 2 sections with problem vs. judgment-call assessment
35 
36## Key constraints
37 
38- The skill must remain a single `SKILL.md` file with agentskills.io-compatible frontmatter
39- Word replacement table entries need specific alternatives, not just "rephrase"
40- The self-reference escape hatch (quoted examples exempt from flagging) must be preserved — without it the skill flags its own documentation
41- Technical-blog profile has explicit word table exceptions (e.g., "robust" and "ecosystem" are legitimate in technical contexts)
42- "Extra strict" and "skip" in the tolerance matrix have specific meanings defined in the file
43- The `ai-writing-skill-field-guide` survey ranks this repo first on upkeep, and its author filed #12 here. Any public citation of that ranking has to carry the disclosure with it
44 
45## Compatibility
46 
47The skill works with Claude Code, OpenClaw/ClawHub, and any agentskills.io-compatible agent. The frontmatter includes both `agentskills_spec` and `openclaw` fields. Changes must not break either format.
48