Skip to content
Skills Library
Programming · Review & audit

verifying-modules

/verifying-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.

Repository
code-abyss ↗
Licence
MIT
Last repository change
19.07.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
3
Scripts
1
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 19.07.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

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.

Arguments

/verifying-modules <模块路径>
Original author description

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.

How it works

  1. 何时使用
  2. 必备文件
  3. 文档要求
  4. 何时豁免
  5. 与其他 skill 联动
  6. 使用
  7. 收口
Original SKILL.md headings · 66 lines, 188 words
SKILL.md preview
---
name: verifying-modules
description: 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.
compatibility: node>=18
user-invocable: false
allowed-tools: Bash, Read, Glob
argument-hint: <模块路径>
---

# 模块完整性校验关卡

> 文档不齐不算交付。模块是否能被外人独立理解,是「完成」的最低门槛。

## 何时使用

| 场景 | 跑 | 理由 |
|------|------|------|
| 新建模块 | ✅ 必跑 | 阻断「无文档落地」 |
| 模块重构(边界变化) | ✅ | 文档随边界更新 |
| 接收他人模块 | ✅ | 检查可理解性 |
| 提交前(涉及模块新增) | ✅ | 最后闸 |
| 仅函数级修改 | ❌ | 走 [analyzing-changes](../analyzing-changes/SKILL.md) 即可 |

## 必备文件

| 文件 | 缺失后果 | 备注 |
|------|----------|------|
| `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](../generating-docs/SKILL.md) 生成骨架,再人工填决策
- 通过后 → 串 [analyzing-security](../analyzing-security/SKILL.md) 扫新增攻击面
- 大改后 → 串 [analyzing-changes](../analyzing-changes/SKILL.md) 看辐射面

## 使用

```bash
node scripts/module_scanner.js <模块路径>
node scripts/module_scanner.js <模块路径> -v       # 详细
node scripts/module_scanner.js <模块路径> --json   # CI 用
```

## 收口

阻断项必修。警告项可在 DESIGN 留「不写测试的理由」(如纯接口声明、纯常量)。**「以后补」不算理由。**
Files in this package (3)
  • SKILL.md 3 KB
  • agents/openai.yaml 1 KB
  • scripts/module_scanner.js 6 KB

Versions

The database has no other skills named verifying-modules.

Database snapshot: 13.11.2026 · package version efe71f1cc753 (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

  • 90create-readme
    Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans ./ directory files and creates a README.md file for the project. Only used when creating a new repository. or when the README.md file is missing.
  • 100generating-docs
    Generates README.md and DESIGN.md scaffolds by analyzing module structure. Use when creating documentation templates for new modules. Automatically triggered at module creation.
  • 100verify-module
    模块完整性校验关卡。扫描目录结构、检测缺失文档、验证代码与文档同步。当用户提到模块校验、文档检查、结构完整性、README检查、DESIGN检查时使用。在新建模块完成时自动触发。
  • 95unikit-docs
    Generate and maintain the project's TECHNICAL documentation from its codebase — scans the project structure, tech stack, and module boundaries, then writes a lean README landing page plus detailed topic pages (architecture, modules, setup, build, APIs), only the docs that are…
  • 86module-readme
    维护模块 README 与版本记录。用户说「文档」「更新 README」时使用。
  • 100readme-creation
    Generate self-contained README files that enable instant developer onboarding. Use when creating or updating directory or root repository documentation. Triggers: "create readme", "readme", "document directory", "write readme", "root readme".

Feedback and reports

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