本文へ移動
cccskills
無料GitHub で公開

verify-module

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

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

インストール方法を見る

含まれるファイル(2)

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

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

⚖ 校验关卡 · 模块完整性

核心原则

模块 = 代码 + 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 <模块路径>

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

adapt

無料

Adapt designs to work across different screen sizes, devices, contexts, or platforms. Implements breakpoints, fluid layouts, and touch targets. Use when the user mentions responsive design, mobile layouts, breakpoints, viewport adaptation, or cross-device compatibility.

日本語の概要は準備中です。原文の説明を表示しています。

fengshao1227/ccg-workflow5,9402026年10月12日 更新

Audit websites for Google AdSense application readiness and ad-serving compliance. Use when checking whether a site is likely to satisfy AdSense eligibility, site ownership, content quality, navigation, crawler access, ads.txt, privacy disclosure, Google Publisher Policies, AdSense Program policies, or when the user asks if a site can apply for AdSense, pass AdSense review, show ads, or fix AdSense rejection/site-not-ready issues.

日本語の概要は準備中です。原文の説明を表示しています。

fengshao1227/ccg-workflow5,9402026年10月12日 更新

ai

無料

AI/LLM 能力索引。Agent 开发、LLM 安全、RAG 系统。当用户提到 AI、LLM、Agent、RAG、Prompt 时路由到此。

日本語の概要は準備中です。原文の説明を表示しています。

fengshao1227/ccg-workflow5,9402026年10月12日 更新

animate

無料

Review a feature and enhance it with purposeful animations, micro-interactions, and motion effects that improve usability and delight. Use when the user mentions adding animation, transitions, micro-interactions, motion design, hover effects, or making the UI feel more alive.

日本語の概要は準備中です。原文の説明を表示しています。

fengshao1227/ccg-workflow5,9402026年10月12日 更新

架构设计能力索引。API设计、安全架构、云原生、数据安全。当用户提到架构、设计、API、云原生时路由到此。

日本語の概要は準備中です。原文の説明を表示しています。

fengshao1227/ccg-workflow5,9402026年10月12日 更新

arrange

無料

Improve layout, spacing, and visual rhythm. Fixes monotonous grids, inconsistent spacing, and weak visual hierarchy. Use when the user mentions layout feeling off, spacing issues, visual hierarchy, crowded UI, alignment problems, or wanting better composition.

日本語の概要は準備中です。原文の説明を表示しています。

fengshao1227/ccg-workflow5,9402026年10月12日 更新

fengshao1227 のスキルをすべて見る

このスキルの問題を報告する