verifying-modules
Enforces documentation standards. Checks for README and DESIGN files to ensure module completeness.
Install
mkdir -p .claude/skills/verifying-modules && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/19515" && unzip -o skill.zip -d .claude/skills/verifying-modules && rm skill.zipInstalls to .claude/skills/verifying-modules
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Scans directory structure, detects missing documentation, and verifies code-doc synchronization. Use when checking module completeness, README presence, or DESIGN.md alignment. Automatically triggered after creating new modules.Key capabilities
- →Scan project directory structure
- →Detect missing mandatory documentation
- →Verify alignment between code and design documents
- →Validate module readiness for delivery
How it works
It scans the directory for required files like README.md and DESIGN.md and verifies that the module meets the minimum documentation standards for delivery.
Inputs & outputs
When to use verifying-modules
- →Check module readiness for delivery
- →Validate design document alignment
- →Detect missing README files
- →Verify documentation for new modules
About this skill
模块完整性校验关卡
文档不齐不算交付。模块是否能被外人独立理解，是「完成」的最低门槛。
何时使用
| 场景 | 跑 | 理由 |
|---|---|---|
| 新建模块 | ✅ 必跑 | 阻断「无文档落地」 |
| 模块重构（边界变化） | ✅ | 文档随边界更新 |
| 接收他人模块 | ✅ | 检查可理解性 |
| 提交前（涉及模块新增） | ✅ | 最后闸 |
| 仅函数级修改 | ❌ | 走 analyzing-changes 即可 |
必备文件
| 文件 | 缺失后果 | 备注 |
|---|---|---|
README.md | 阻断交付 | 用户视角 |
DESIGN.md | 阻断交付 | 维护者视角 |
tests/ | 警告 | 单文件模块或纯类型声明可豁免 |
__init__.py | 提示（仅 Python） | 视项目布局而定 |
文档要求
README（外部视角，回答「这是什么、怎么用」）
- 模块名与定位
- 存在理由（解决什么问题，不是列功能清单）
- 核心职责（一句话）
- 依赖关系（上游：依赖什么；下游：被谁依赖）
- 快速使用示例（5 分钟跑通）
DESIGN（内部视角，回答「为什么这样设计」）
- 设计目标（含非目标）
- 方案选择与理由（对比 ≥2 选项）
- 关键决策（含权衡）
- 已知限制
- 变更历史（重大设计调整）
何时豁免
- 生成代码模块（protobuf、OpenAPI client 等）→ 顶级 README 提一句即可，无需 DESIGN
- 配置/数据模块（fixtures、seed data）→ README 说明用途与字段含义即可
- 私有 utility（
_internal/、internal/）→ README 简化，DESIGN 可缺
与其他 skill 联动
- 缺文档 → 用 generating-docs 生成骨架，再人工填决策
- 通过后 → 串 analyzing-security 扫新增攻击面
- 大改后 → 串 analyzing-changes 看辐射面
使用
node scripts/module_scanner.js <模块路径>
node scripts/module_scanner.js <模块路径> -v # 详细
node scripts/module_scanner.js <模块路径> --json # CI 用
收口
阻断项必修。警告项可在 DESIGN 留「不写测试的理由」（如纯接口声明、纯常量）。「以后补」不算理由。
When not to use it
- →Function-level modifications
- →Purely internal utility modules
Prerequisites
Limitations
- →Requires manual filling of design decisions
- →Does not replace human review of design logic
How it compares
It enforces a strict 'no documentation, no delivery' policy that is automatically triggered after module creation.
Compared to similar skills
verifying-modules side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| verifying-modules (this skill) | 0 | 2mo | Review | Beginner |
| deepwiki-rs | 25 | 9mo | Review | Intermediate |
| python-code-style | 9 | 5mo | Review | Intermediate |
| code-review-excellence | 19 | 4mo | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
deepwiki-rs
sopaco
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.
python-code-style
wshobson
Python code style, linting, formatting, naming conventions, and documentation standards. Use when writing new code, reviewing style, configuring linters, writing docstrings, or establishing project standards.
code-review-excellence
wshobson
Master effective code review practices to provide constructive feedback, catch bugs early, and foster knowledge sharing while maintaining team morale. Use when reviewing pull requests, establishing review standards, or mentoring developers.
code-walk-thru
pchalasani
Use this when user wants you to walk through (code or text) files in a EDITOR to either explain how some code works, or to show the user what changes you made, etc. You would typically use this repeatedly to show the user your changes or code files one by one, sometimes with specific line-numbers. This way the user is easily able to follow along in their favorite EDITOR as you point at various files possibly at specific line numbers within those files.
cookbook-audit
anthropics
Audit an Anthropic Cookbook notebook based on a rubric. Use whenever a notebook review or audit is requested.
schema-markup
davila7
When the user wants to add, fix, or optimize schema markup and structured data on their site. Also use when the user mentions "schema markup," "structured data," "JSON-LD," "rich snippets," "schema.org," "FAQ schema," "product schema," "review schema," or "breadcrumb schema." For broader SEO issues, see seo-audit.