Skip to content
Skills Library
Programming · Review & audit

verify-module

/verify-module

模块完整性校验关卡。扫描目录结构、检测缺失文档、验证代码与文档同步。当用户提到模块校验、文档检查、结构完整性、README检查、DESIGN检查时使用。在新建模块完成时自动触发。

Licence
MIT
Last repository change
21.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
2
Scripts
1
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 21.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What to check before installing
  • 1 scripts in this package. Review them before installing, as Claude may execute them.

Scripts: scripts/module_scanner.js

What it does and when to use it

模块完整性校验关卡。扫描目录结构、检测缺失文档、验证代码与文档同步。当用户提到模块校验、文档检查、结构完整性、README检查、DESIGN检查时使用。在新建模块完成时自动触发。

Arguments

/verify-module <模块路径>
Original author description

模块完整性校验关卡。扫描目录结构、检测缺失文档、验证代码与文档同步。当用户提到模块校验、文档检查、结构完整性、README检查、DESIGN检查时使用。在新建模块完成时自动触发。

How it works

  1. 核心原则
  2. 自动扫描
  3. 校验标准
  4. 检测项
  5. 自动触发时机
  6. 校验流程
  7. 校验报告格式
  8. 快速修复
Original SKILL.md headings · 118 lines, 317 words
SKILL.md preview
---
name: verify-module
description: 模块完整性校验关卡。扫描目录结构、检测缺失文档、验证代码与文档同步。当用户提到模块校验、文档检查、结构完整性、README检查、DESIGN检查时使用。在新建模块完成时自动触发。
license: MIT
compatibility: node>=18
user-invocable: true
disable-model-invocation: false
allowed-tools: Bash, Read, Glob
argument-hint: <模块路径>
---

# ⚖ 校验关卡 · 模块完整性


## 核心原则

```
模块 = 代码 + README.md + DESIGN.md
缺一不可,残缺即异端
```

## 自动扫描

运行扫描脚本(跨平台):

```bash
# 在 verify-module 目录下运行(推荐)
node scripts/module_scanner.js <模块路径>
node scripts/module_scanner.js <模块路径> -v      # 详细模式
node scripts/module_scanner.js <模块路径> --json  # JSON 输出
```

## 校验标准

一个完整的模块必须包含:

```
module/
├── README.md      # 必须 - 模块是什么、为什么存在
├── DESIGN.md      # 必须 - 设计决策、权衡取舍
├── src/           # 代码实现
└── tests/         # 测试用例(如适用)
```

## 检测项

### 必须存在

| 文件 | 说明 | 缺失后果 |
|------|------|----------|
| `README.md` | 模块说明文档 | 🔴 阻断交付 |
| `DESIGN.md` | 设计决策文档 | 🔴 阻断交付 |

### 推荐存在

| 文件/目录 | 说明 | 缺失后果 |
|-----------|------|----------|
| `tests/` | 测试目录 | 🟠 警告 |
| `__init__.py` | Python 包标识 | 🟡 提示 |
| `.gitignore` | Git 忽略配置 | 🔵 信息 |

### README.md 必须包含

- [ ] **模块名称与定位** — 一句话说明是什么
- [ ] **存在理由** — 为什么需要这个模块
- [ ] **核心职责** — 做什么、不做什么
- [ ] **依赖关系** — 依赖谁、被谁依赖
- [ ] **快速使用** — 最简示例

### DESIGN.md 必须包含

- [ ] **设计目标** — 要解决什么问题
- [ ] **方案选择** — 考虑过哪些方案、为何选当前方案
- [ ] **关键决策** — 重要的技术决策及理由
- [ ] **已知限制** — 当前方案的局限性
- [ ] **变更历史** — 重大变更记录

## 自动触发时机

| 场景 | 触发条件 |
|------|----------|
| 新建模块 | 模块创建完成时 |
| 模块重构 | 重构完成时 |
| 提交前 | 代码提交前检查 |

## 校验流程

```
1. 运行 module_scanner.js 自动扫描
2. 检查文件结构是否完整
3. 检查 README.md 各项是否齐全
4. 检查 DESIGN.md 各项是否齐全
5. 检查代码与文档描述是否一致
6. 输出校验报告
```

## 校验报告格式

```
## 模块校验报告

### 模块: <模块名>

✓ 通过 | ✗ 未通过

### 文件检查
- README.md: ✓ 存在 / ✗ 缺失
- DESIGN.md: ✓ 存在 / ✗ 缺失
- tests/: ✓ 存在 / ⚠️ 缺失

### 内容检查
- README 完整性: ✓ 完整 / ⚠️ 缺少 [X, Y, Z]
- DESIGN 完整性: ✓ 完整 / ⚠️ 缺少 [X, Y, Z]

### 结论
可交付 / 需补充后交付
```

## 快速修复

如果缺少文档,可使用文档生成器:

```bash
/gen-docs <模块路径>
```

---
Files in this package (2)
  • SKILL.md 3 KB
  • scripts/module_scanner.js 6 KB

Versions

The database has no other skills named verify-module.

Identical content appears in 2 other GitHub folders. We show one copy with the highest score.

Database snapshot: 13.11.2026 · package version 23fa5163e107 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 85{setup-skill-name}
    Sets up {module-name} module in a project. Use when the user requests to 'install {module-code} module', 'configure {module-name}', or 'setup {module-name}'.
  • 100verifying-modules
    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.
  • 100port-c-module
    Guide for porting a C module to Rust. Use this when starting to port a C module to Rust.
  • 100audit-logic
    This skill should be used when the user asks to "audit logic bugs", "read all source files and find bugs", "gate tầng 0", "logic check a module", "verify module correctness", "find business logic bugs", "audit this module before drawing diagrams", or says "read every line of…
  • 95sdd-verify
    Use when verifying that an implementation matches a change's SDD artifacts. Triggers: "verify", "check implementation", "did I implement everything", "verify the change", "is implementation complete", "check conformance".
  • 100om-find-module
    Before building a feature in an Open Mercato app, search the module registry (built-in core modules first, then official and community modules), check what is verified on this app's Open Mercato version, show the install plan and agent policy, and install only after the user…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.