blueprint-docs-currency

Solid

Enforce same-commit landing of code and docs (APIs, formats, ADRs). Use when committing API/format changes, promoting research to docs/, or landing an ADR decision.

Code & Development 48 stars 6 forks Updated today MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
56
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Blueprint Docs Currency Same-commit discipline for code and documentation. This skill is the reusable version of claude-plugins' `.claude/rules/docs-currency.md`, refined for blueprint-driven projects. ## When to Use This Skill | Use this skill when… | Skip when… | |---------------------|------------| | Committing code that changes a public API, format spec, or error enum | Refactoring internal helpers with no external surface change | | Promoting research findings from `tmp/` to `docs/` | Scratch work that will not ship | | Landing an architectural decision | Implementation detail with no branching trade-off | | Advancing a tracker entry past "in progress" | Small task completion that does not cross a phase gate | | A reviewer flags missing documentation | Typo fixes or whitespace changes | ## The Rule > Code + its docs land in the same commit. Research promotes to `docs/` > before the feature advances past "in progress." ADR-worthy decisions > land with a new or updated ADR in the same commit. ## Same-commit scope | Change kind | Doc target | |-------------|-----------| | Public API / exported type | Inline docstring + reference doc under `docs/api/` (or tool-appropriate) | | File-format spec | `docs/format-spec/<name>.md` (hand-written prose, not generated) | | Error enum / protocol code | `docs/errors/<name>.md` or the protocol reference | | Milestone / phase status | Feature-tracker entry + `docs/PLAN.md` if the phase advanced | | Architectural decision | New AD...

Details

Author
laurigates
Repository
laurigates/claude-plugins
Created
7 months ago
Last Updated
today
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category