Pretty Mermaid Renderer
imxv/Pretty-mermaid-skills
Writes and renders Mermaid diagrams as themed SVG, PNG or terminal ASCII and Unicode art with a bundled Node.js CLI that needs no browser.
Scans a module directory for the required README.md and DESIGN.md plus recommended files and reports what is missing, so a module is not delivered incomplete.
SKILL.md written in Chinese; this summary is our English description.
Install Module Completeness Check
$ npx skills add fengshao1227/ccg-workflow --skill verify-module -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install fengshao1227/ccg-workflow verify-module --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .claude/skills && cp -r skills-src/dsh-ccg/skills/verify-module .claude/skills/verify-module && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "verify-module" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/verify-module into .claude/skills/verify-module/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "verify-module", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/verify-moduleType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add fengshao1227/ccg-workflow --skill verify-module -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install fengshao1227/ccg-workflow verify-module --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .agents/skills && cp -r skills-src/dsh-ccg/skills/verify-module .agents/skills/verify-module && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "verify-module" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/verify-module into .agents/skills/verify-module/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "verify-module", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add fengshao1227/ccg-workflow --skill verify-module -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install fengshao1227/ccg-workflow verify-module --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/dsh-ccg/skills/verify-module .cursor/skills/verify-module && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "verify-module" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/verify-module into .cursor/skills/verify-module/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "verify-module", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/fengshao1227/ccg-workflow.git --path dsh-ccg/skills/verify-module--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add fengshao1227/ccg-workflow --skill verify-module -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install fengshao1227/ccg-workflow verify-module --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/dsh-ccg/skills/verify-module .gemini/skills/verify-module && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "verify-module" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/verify-module into .gemini/skills/verify-module/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "verify-module", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install fengshao1227/ccg-workflow verify-moduleInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add fengshao1227/ccg-workflow --skill verify-module -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .github/skills && cp -r skills-src/dsh-ccg/skills/verify-module .github/skills/verify-module && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "verify-module" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/verify-module into .github/skills/verify-module/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "verify-module", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add fengshao1227/ccg-workflow --skill verify-module -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install fengshao1227/ccg-workflow verify-module --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/dsh-ccg/skills/verify-module .opencode/skills/verify-module && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "verify-module" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/verify-module into .opencode/skills/verify-module/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "verify-module", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
verify-module- GitHub stars
- 5.9k
- Token cost
- ~473 tokens
- SKILL.md length
- 70 words
- Files
- 2 (incl. scripts)
- Skills in repo
- 6
- Repo updated
- First seen
- Licence
- MIT
At a glance
Scans a module directory for the required README.md and DESIGN.md plus recommended files and reports what is missing, so a module is not delivered incomplete.
- Checking a newly created module for README.md and DESIGN.md
- SKILL.md covers 核心原则, 自动扫描, 校验标准 and 检测项, plus 4 more sections
- Runs JavaScript scripts from its folder; calls node
- Verifying that module docs still match the code after a refactor
What it does
Written in Chinese, this skill treats a module as code plus README.md plus DESIGN.md, with all three required. The bundled scripts/module_scanner.js scans the module path you give it, with a verbose option, and the agent then checks the file structure, the sections each document must contain and whether the code and the docs still agree.
A missing README.md or DESIGN.md blocks delivery, while a missing tests folder is a warning, a missing __init__.py a hint and a missing .gitignore only informational. The README must cover the module's name and purpose, why it exists, its responsibilities, dependencies and a quick usage example. DESIGN.md must cover goals, options considered, key decisions, known limits and change history. The check runs after a module is created or refactored and before commits, produces a validation report and points to the /gen-docs command for missing docs.
When your agent uses it
- Checking a newly created module for README.md and DESIGN.md
- Verifying that module docs still match the code after a refactor
- Running a structure check before committing
Example prompts
- “Verify the module in src/payments for missing docs.”
- “Run the module scanner on ./auth in verbose mode and show me the report.”
- “Check that the new cache module has a complete README and DESIGN file.”
Requirements
- Node.js 18 or newer
- Compatibility (from SKILL.md): node>=18
- Pre-approved tools (allowed-tools): Bash, Read, Glob
What it can do on your machine
Read from SKILL.md and the folder at commit f349e3d. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
BashReadGlob
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 1 file in scripts/ (JavaScript), which the agent can run.
Shell commands in SKILL.md call:
node
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Compatibility
node>=18
From compatibility in the SKILL.md frontmatter.
Context cost
Module Completeness Check loads about 473 tokens when it runs. Until then it costs about 26 tokens; SKILL.md has 70 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check: notes
The automated check noted patterns worth knowing about, such as sudo or a known installer.
- NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
allowed-tools: Bash, Read, Glob
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.
SKILL.md
The full file from fengshao1227/ccg-workflow at commit f349e3d, republished under its MIT licence (© fengshao1227). 70 words, ~473 tokens.
Download SKILL.mdSave it as
.claude/skills/verify-module/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.- name
- verify-module
- description
- 模块完整性校验关卡。扫描目录结构、检测缺失文档、验证代码与文档同步。当用户提到模块校验、文档检查、结构完整性、README检查、DESIGN检查时使用。在新建模块完成时自动触发。
- allowed-tools
- Bash, Read, Glob
- compatibility
- node>=18
- license
- MIT
- user-invocable
- true
- disable-model-invocation
- false
- argument-hint
- <模块路径>
⚖ 校验关卡 · 模块完整性
核心原则
模块 = 代码 + 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__.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]
### 结论
可交付 / 需补充后交付快速修复
如果缺少文档，可使用文档生成器：
/gen-docs <模块路径>© fengshao1227, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 1 other file (scripts) in dsh-ccg/skills/verify-module of fengshao1227/ccg-workflow.
- SKILL.md
- scripts/module_scanner.js
Open the folder on GitHubat commit f349e3d
Compare with similar skills
Module Completeness Check next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Module Completeness Check this skillfengshao1227/ccg-workflow | 5.9k | — | ~473 | Automated safety check: Notes | MIT | |
| Pretty Mermaid Rendererimxv/Pretty-mermaid-skills | 1.5k | — | ~2k | Automated safety check: Pass | MIT | |
| BiSheng SDD Document Reviewdataelement/bisheng | 12k | — | ~717 | Automated safety check: Pass | Apache-2.0 | |
| GAIA Agent Eval Scorecardamd/gaia | 1.6k | — | ~2.6k | Automated safety check: Pass | MIT | |
| Review PRGEOLYTIX/xyz | 133 | — | ~4.1k | Automated safety check: Pass | MIT | |
| Maintainer Docs Legibility Checkliaohch3/claude-tap | 3.3k | — | ~561 | Automated safety check: Pass | MIT |
Similar skills
BiSheng SDD Document Review
dataelement/bisheng
Reviews BiSheng spec, design and tasks documents with checklists for PRD gaps, handover readiness and acceptance traceability, producing a report or an LGTM.
GAIA Agent Eval Scorecard
amd/gaia
Adds a release eval scorecard to a GAIA hub agent by writing a harness adapter, running a real eval, and wiring the result into the agent's README and release gate.
Review PR
GEOLYTIX/xyz
A skill your agent uses when reviewing a pull request, a branch, or uncommitted working changes in the XYZ/MAPP repository — whether the user asks to "review this PR", "check my changes before I…
Maintainer Docs Legibility Check
liaohch3/claude-tap
Runs local checks on maintainer docs for stale review dates, missing manifest paths and plan state drift, matching what the CI workflow enforces.
- Official
Generate Readme
microsoft/Agent365-Samples
Generates or updates a README.md for an Agent 365 sample agent.
More from fengshao1227/ccg-workflow
Change Verification Gate
fengshao1227/ccg-workflow
Analyzes a code diff for documentation sync, test coverage and impact scope, warning when docs or tests lag behind a design-level change or a large edit.
Code Quality Gate
fengshao1227/ccg-workflow
Scans code for complexity, long functions, duplicated blocks, naming problems and code smells with a Node script, then reports and suggests refactors.
Security Verification Gate
fengshao1227/ccg-workflow
Scans code with a bundled Node script for injection, secrets, XSS and other risky patterns, ranks findings by severity and checks that security decisions are documented.
README and DESIGN Generator
fengshao1227/ccg-workflow
Generates README.md and DESIGN.md skeletons for a module by scanning its structure with a Node script, then lists what to fill in by hand.
Ccg Workflow
fengshao1227/ccg-workflow
How to run a non-trivial change end to end with the CCG role tools (ccganalyze / ccgdesign / ccgbuild / ccgdebug / ccgoptimize / ccgreview / ccgtest) and the verify- quality gates.
Related
Works with
Categories
Questions about Module Completeness Check
What does Module Completeness Check do?
Scans a module directory for the required README.md and DESIGN.md plus recommended files and reports what is missing, so a module is not delivered incomplete. md, with all three required.js scans the module path you give it, with a verbose option, and the agent then checks the file structure, the sections each document must contain and whether the code and the docs still agree.
When should I use Module Completeness Check?
Module Completeness Check fits situations like: checking a newly created module for README.md and DESIGN.md; verifying that module docs still match the code after a refactor; running a structure check before committing.
How do I install Module Completeness Check in Claude Code?
Run `npx skills add fengshao1227/ccg-workflow --skill verify-module -a claude-code`. Or copy the skill folder (dsh-ccg/skills/verify-module in fengshao1227/ccg-workflow) into .claude/skills/verify-module in your project. Claude Code loads it when a task matches its description.
How do I install Module Completeness Check in Codex?
Run `npx skills add fengshao1227/ccg-workflow --skill verify-module -a codex`. Or copy the skill folder (dsh-ccg/skills/verify-module in fengshao1227/ccg-workflow) into .agents/skills/verify-module in your project. Codex loads it when a task matches its description.
Can I use Module Completeness Check in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add fengshao1227/ccg-workflow --skill verify-module -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/verify-module, .gemini/skills/verify-module, .github/skills/verify-module and .opencode/skills/verify-module in your project.
What does Module Completeness Check need to run?
Going by SKILL.md and its folder, Module Completeness Check needs JavaScript for the scripts in its folder and the command-line tools its instructions call (node). Our summary lists: Node.js 18 or newer. Its frontmatter pre-approves these tools: Bash, Read, Glob. Compatibility (from SKILL.md): node>=18.
Does Module Completeness Check access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Module Completeness Check safe to install?
Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
What licence does Module Completeness Check use?
Module Completeness Check is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Module Completeness Check use?
About 473 tokens (SKILL.md is roughly 1.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Module Completeness Check?
Skills that share tags, products or a category with Module Completeness Check: Pretty Mermaid Renderer (imxv/Pretty-mermaid-skills, 1.5k stars), BiSheng SDD Document Review (dataelement/bisheng, 12k stars), GAIA Agent Eval Scorecard (amd/gaia, 1.6k stars) and Review PR (GEOLYTIX/xyz, 133 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Module Completeness Check?
fengshao1227 (a GitHub user) maintains it in fengshao1227/ccg-workflow, which has 5,928 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on September 15, 2026.
Source: fengshao1227/ccg-workflow on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.