From code-abyss
Scans directory structure, detects missing documentation (README, DESIGN), and verifies code-doc synchronization. Automatically triggered after creating new modules.
How this skill is triggered — by the user, by Claude, or both
Slash command
/code-abyss:verifying-modules <模块路径><模块路径>This skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
> 文档不齐不算交付。模块是否能被外人独立理解,是「完成」的最低门槛。
文档不齐不算交付。模块是否能被外人独立理解,是「完成」的最低门槛。
| 场景 | 跑 | 理由 |
|---|---|---|
| 新建模块 | ✅ 必跑 | 阻断「无文档落地」 |
| 模块重构(边界变化) | ✅ | 文档随边界更新 |
| 接收他人模块 | ✅ | 检查可理解性 |
| 提交前(涉及模块新增) | ✅ | 最后闸 |
| 仅函数级修改 | ❌ | 走 analyzing-changes 即可 |
| 文件 | 缺失后果 | 备注 |
|---|---|---|
README.md | 阻断交付 | 用户视角 |
DESIGN.md | 阻断交付 | 维护者视角 |
tests/ | 警告 | 单文件模块或纯类型声明可豁免 |
__init__.py | 提示(仅 Python) | 视项目布局而定 |
_internal/、internal/)→ README 简化,DESIGN 可缺node scripts/module_scanner.js <模块路径>
node scripts/module_scanner.js <模块路径> -v # 详细
node scripts/module_scanner.js <模块路径> --json # CI 用
阻断项必修。警告项可在 DESIGN 留「不写测试的理由」(如纯接口声明、纯常量)。「以后补」不算理由。
npx claudepluginhub telagod/code-abyss --plugin code-abyssGenerates README.md and DESIGN.md scaffolds by analyzing module structure (Python docstrings, deps, class signatures). Use for new modules or when verifying-modules reports missing docs.
Audits codebase documentation against actual behavior, producing a severity-tagged drift report (STALE, MISSING, OUTDATED, DUPLICATE). Read-only review.
Scans codebase structure, tech stack, config, and architecture to verify documentation accuracy, detect drift, score trust, and generate update reports or PRs.