Repository navigation
Replace the doc-style checker with a documentation maintenance skill - #10
Merged
Merged
Conversation
The doc-style skill directs Claude to keep comments, docstrings, and documents accurate when code changes. Claude finds the prose that a change affects, then edits, consolidates, or deletes it before it adds more. Documentation describes the current system. Commit messages and changelogs hold the change history. - Rewrite SKILL.md as instructions only. Add maintenance examples and revise the rewrite examples. - Remove the Bash checker, the .doc-style configuration and suppressions, the doc-style-check command, the bats and mutation tests, and the ASD-STE100 comparison. - Add a SessionStart hook that prints the primer. Without it, Claude did not load the skill for tasks that asked only for a code change. - Add eval cases for claude plugin eval. - Reduce CI to the plugin validation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
doc-styleskill now maintains documentation. It no longer checks prose against fixedrules. When Claude changes code, the skill directs it to find the comments, docstrings, and
documents that describe the changed code. Claude edits, consolidates, or deletes that prose
before it adds more. This change removes the Bash checker and its tests.
Changes
skills/doc-style/SKILL.mdholds instructions only:skills/doc-style/examples/maintenance.mdgives eight maintenance decisions, with thetext before and after.
skills/doc-style/examples/rewrites.mdgives sentence rewrites, each judged in context.hooks/hooks.jsonadds aSessionStarthook that printssnippets/CLAUDE.mdinto thecontext of each session. In eval runs on Sonnet without the hook, Claude loaded the skill
in 0 of 7 tasks that asked only for a code change. With the hook, it loaded the skill in
every run.
evals/holds nine cases forclaude plugin eval. Each case copies a small workspacewith
scaffold.shand grades the files that Claude leaves.skills/doc-style/scripts/check,rules.md, anddeviations.md;.doc-styleandcommands/doc-style-check.md;tests/and.github/workflows/mutate.yml;mise.tomlandmise.lock.claude plugin validate.mise.ci.tomlstill pins the Claude Code versionfor that step.
Compatibility
/haddock:doc-style-checkcommand is removed. A.doc-stylefile has no effect.version changes.
Validation
claude plugin validate .passes with Claude Code 2.1.292, the version that CI pins.shellcheckandshfmt -dpass on thescaffold.shfiles.claude plugin eval . --scaffold --allow-tools Edit Writeran each case with andwithout the plugin. A score is the fraction of graders that passed:
Without the plugin, Claude did not do these updates:
In a three-turn
claude -p --resumesession on Sonnet, Claude loaded the skill once. Itdid not load the skill again for the two later code changes.
Known limitations
them in 6 of 6 runs.
commit history.
person who runs it.