Enforces documentation wording rules for Markdown files, code comments, and commit messages.
npx skills add https://github.com/Eyhenij/rt-tools --skill doc-style-eyhenij
Please help me install this Agent Skill. Skill: doc-style Source: https://github.com/Eyhenij/rt-tools/tree/main/.claude/skills/doc-style Command: npx skills add https://github.com/Eyhenij/rt-tools --skill doc-style-eyhenij
Docs-skip: <reason> bypass for exceptions. - Glossary discipline: Terms come from the project glossary rather than being invented, and texts for owners use product language instead of internal jargon. - Use Case: When editing a spec, README, or PR description, load this rule to verify that named paths exist, numbers are recomputed by command, and the document accompanies its code change. ## Quick Start Load the doc-style rule before editing any Markdown file, code comment, commit body, or PR description and follow its checks for paths, numbers, and glossary terms.High-intent search queries and answers about installing and using this skill.
Commit each document in the same commit as the change it describes, enforced by a docs-guard hook on defined edit-document pairs. If a pair genuinely does not apply, add a `Docs-skip: <reason>` line to the commit body with a non-empty reason.
Run the path check command (`npm run check:docs`), which searches the tree from version control so dot-directories are included. Bare file names are searched across the whole tree, and archives plus portable laid-out files are excluded.
Docs-skip is a line in the commit body that bypasses the requirement that a document ship with its change. It must include a non-empty reason; an empty reason is rejected by the guard.
Numbers go stale within a single branch because no check watches them. If a number must be written, recompute it with a command in the same commit, or omit it entirely when it would need constant recomputation.
Yes, the rule covers code comments, commit bodies, and PR descriptions, but the automated gate only checks `.md` files. Comments and owner-facing texts are held by the author, with owner-facing texts written in product language rather than internal glossary terms.
Records of closed work go to the archive with an expiry set by `archiveRetentionDays`, after which they are removed. A file moving to the archive must name its former address in its header so old references remain traceable.
GainInsightDevValidate domain terminology in BDD scenarios against a canonical glossary.
jbrukhImproves drafts section-by-section with guided user feedback loops.
jongensutrechtCapture proven learnings from completed runs into LEARNINGS.md files.
radius-projectLint and fix Markdown files using markdownlint-cli2 and markdown-table-formatter.