Skip to content
cccskills
FreePublished on GitHub

verify-module

Check a software module’s folder structure, required README.md and DESIGN.md files, and whether documentation matches the code. Produce a report identifying missing content and issues to resolve before handoff.

OriginalShow the original description

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

在新建模块完成时自动触发。

See how to install

Good for

  • Checking a newly created module before handoff
  • Reviewing documentation after refactoring
  • Finding missing README.md and DESIGN.md sections
  • Checking module completeness before a commit

Files included (2)

  • SKILL.md3.1 KB
  • scripts/module_scanner.js6.1 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

⚖ 校验关卡 · 模块完整性

核心原则

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

自动扫描

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

# 在 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__.pyPython 包标识🟡 提示
.gitignoreGit 忽略配置🔵 信息

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]

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

快速修复

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

/gen-docs <模块路径>

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

adapt

FreeSummary

Adapts existing designs for phones, tablets, desktops, print, and email. Adjusts layouts, navigation, content priorities, and touch controls to suit each context, with guidance for responsive sizing and verification across devices and input methods.

  • Adapting a desktop interface for mobile use
  • Adjusting tablet layouts for portrait and landscape
  • Expanding a mobile design for desktop screens
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

Audit a website for Google AdSense application readiness or ongoing ad-serving issues. Check content, navigation, crawler access, and disclosures against official requirements, then receive evidence-based findings, specific fixes, and a complete checklist with unresolved questions clearly marked.

  • Checking a site before applying for AdSense
  • Investigating issues after an AdSense rejection
  • Reviewing policy risks on a site that already serves ads
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

ai

FreeSummary

Routes AI development questions to focused references on agents, language model security, retrieval-augmented generation, which uses retrieved information in answers, and prompt design and evaluation. It also outlines principles for validation, safety boundaries, version control, and ongoing assessment.

  • Find guidance for agent development
  • Locate references on prompt injection defenses
  • Explore retrieval and reranking for RAG
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

animate

FreeSummary

Review an interface and add purposeful motion to buttons, forms, navigation, and state changes. Plan and implement animations that clarify actions and provide feedback, while checking performance and supporting users who prefer reduced motion.

  • Adding visual feedback to buttons and forms
  • Smoothing menu, modal, and tab transitions
  • Planning page entrances and scroll reveals
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

architecture

FreeSummary

Find the relevant architectural guidance for API design, security, cloud infrastructure, message queues, and caching. This skill acts as an index to specialized references and lists principles for structuring software, distributed systems, and access controls.

  • Finding guidance for API design
  • Reviewing security architecture topics
  • Exploring containers, K8s, and Serverless
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

arrange

FreeSummary

Improve interface layouts by reviewing spacing, alignment, content density, and visual hierarchy, the cues that show what matters most. Refine repetitive card grids and crowded sections into compositions with consistent spacing and responsive structure.

  • Adjusting spacing in a crowded interface
  • Making important content easier to spot
  • Varying repetitive card-based layouts
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

See all skills by fengshao1227

Report a problem with this skill