Repository navigation
Rename the skill to doc-maintenance and set the version to 0.5.0 - #11
Merged
Merged
Conversation
The skill directory, the skill name, and every reference to them use doc-maintenance. The plugin name stays haddock. /haddock:doc-maintenance loads the skill on demand. - Restate the docstring rule: a docstring documents the non-obvious caller-visible contract. It does not repeat what the signature, the types, or the surrounding code show. - Direct Claude to read the README section and the documentation page of the changed component, even when a search for the changed names finds no match. - Add eval graders that check the new ADR in historical-adr and the retry behavior in restating-comment. - Run the LLM graders on Sonnet. The default Haiku judge answers without extended thinking and fails correct retry code.
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 skill is now named
doc-maintenance, and the plugin version is 0.5.0. The plugin namestays
haddock. The change also restates the docstring rule, directs Claude to readdocuments that a name search does not find, and extends two eval cases.
Changes
skills/doc-style/is nowskills/doc-maintenance/, and the frontmatter setsname: doc-maintenance. The README,CLAUDE.md, the primer, the plugin and marketplacedescriptions, and the
skill-loadedgraders use the new name..claude-plugin/plugin.jsonsets version 0.5.0.marketplace.jsonhas no versionfield, so the manifest is the only source of the version.
including constraints, errors, and side effects. It does not repeat what the signature,
the types, or the surrounding code show.
the behavior without naming an identifier. Claude reads the README section and the
documentation page of the changed component even when the search finds no match.
evals/historical-adrchecks that Claude createsdocs/adr/0005-*.mdand that itsDecision section names Redis.
evals/restating-commentchecks the retry behavior with an LLM grader that judges thebehavior, not the code structure.
CLAUDE.mdadds--judge-model sonnet. The defaultjudge, Haiku, answers without extended thinking. It failed correct retry code in every
run.
Compatibility
/haddock:doc-styleandskills/doc-style/no longer exist. A link toskills/doc-stylefrom an install by hand breaks.claude plugin marketplace update throw-if-nulland
claude plugin update haddock@throw-if-null.Validation
claude plugin validate .passes with Claude Code 2.1.287 and 2.1.292, the versionthat CI pins. 2.1.292 gives one warning:
CLAUDE.mdat the plugin root is not loaded asproject context. That file holds the repository instructions.
In an isolated configuration directory, an install from the marketplace gives 0.5.0
with
skills/doc-maintenance/SKILL.md. The two update commands above change aninstalled 0.4.0 to 0.5.0.
No reference to
doc-styleor 0.4.0 remains.Eval results:
readme-consolidated. The skill loaded in 9 of 9 cases.retry-implemented(the Haiku judge defect) andcomment-judgmentinobsolete-comment.With the Sonnet judge,
retry-implementedpassed two correct implementations andfailed two incorrect implementations, 3 of 3 votes each.
The new ADR graders passed in 4 of 4 runs.
After the step 2 change, Sonnet updated the README table in
unrelated-cleanupin 5 of7 runs. Before the change, it did so in 3 of 9 runs.
No shell script changed.
Known limitations
readme-consolidatedinevery run. Opus passed it in 7 of 7 runs. The grader stays strict, because two copies of
a fact can diverge.
comment-judgmentinobsolete-commentfailed some Opus outputsthat keep a valid constraint. Opus with the Sonnet judge is not tested.
duplicate-docsworkspace is close to example 3 inexamples/maintenance.md. Thecase does not show whether Claude follows the rule or copies the example.