check-design-doc

Community

Ensure code and design docs stay aligned.

AuthorsunLeee
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Helps teams keep code implementations and CLAUDE design documents synchronized across PRs by validating consistency between code contracts and design guidelines.

Core Features & Use Cases

  • Consistency checks: compares function signatures, module paths, and documented interfaces to catch mismatches.
  • Documentation alignment: verifies CLAUDE.md and docs/design/ references align with the actual code.
  • PR hygiene: prevents merge regressions by surfacing drift before submission.

Quick Start

Run the consistency check on the current pull request to verify alignment between code and design documents.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: check-design-doc
Download link: https://github.com/sunLeee/optimization/archive/main.zip#check-design-doc

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.