skills.rest
sunLeee
sunLeeeCOMMUNITY
Explore all skills by this author →
GitHub

check-design-doc

Validate code signatures against CLAUDE.md and docs/design/ API patterns.

Updated Mar 19, 2026
Search Tags:#documentation#code-quality#validate#pull-request#design-docs#code-signatures
One-click install
npx skills add https://github.com/sunLeee/optimization --skill check-design-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: check-design-doc
Source: https://github.com/sunLeee/optimization/tree/main/.claude/skills/quality/check/design-doc
Command: npx skills add https://github.com/sunLeee/optimization --skill check-design-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about check-design-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate code signatures against design docs in a pull request?▼

To validate code signatures against design docs, run a consistency check on your pull request to compare function signatures, import styles, and file layouts against documented interfaces in CLAUDE.md and docs/design/.

How do I keep CLAUDE.md documentation aligned with actual code implementations?▼

Keep CLAUDE.md documentation aligned by validating that your code contracts, module paths, and documented interfaces conform to AW-006 patterns, surfacing any drift before pull request submission.

Does the design doc consistency check execute my code or modify runtime states?▼

Design doc consistency checks do not execute code or modify runtime states; they use only static type hints and documented conventions to validate file layouts and function signatures without side effects.

What is the best way to prevent design doc drift before merging a pull request?▼

The best way to prevent design doc drift is to check pull requests for mismatches between code signatures and the designed API, ensuring function signatures and import styles conform to AW-006 patterns.

Can I check module paths and import styles against documented interfaces across a repository?▼

You can check module paths and import styles by validating them against documented interfaces across the repository, ensuring type-safe consistency between your code and design guidelines.

Related Skills

Explore More Software Engineering Skills→
sunLeeesunLeee

claude-md-improver

Audit CLAUDE.md files against the current codebase and generate update recommendations.

Community
Intermediate
lehalpaullehalpaul

merge-pr

Merge GitHub pull requests via squash and clean up worktrees.

Community
Advanced
ekremmkasapekremmkasap

python-type-safety

Enforce static type safety in Python with mypy or pyright.

Community
Advanced
SalesforceCommerceCloudSalesforceCommerceCloud
51

b2c-custom-api-development

Design and deploy Custom SCAPI endpoints for B2C Commerce.

Official
Advanced