Verifying Modules
This is a gatekeeper for module completeness that won't let you ship without both a README and DESIGN.md. It scans your directory structure and flags missing documentation, runs automatically after you create new modules, and treats docs as delivery blockers, not nice-to-haves. The philosophy is straightforward: if another developer can't understand your module independently, it's not done. It distinguishes between user-facing README (what and how) and maintainer-facing DESIGN (why and tradeoffs), with exemptions for generated code and config-only modules. The "later" excuse doesn't fly here. You either document your decisions now or you don't merge.
- GitHub stars
- 224
- last updated
- Jun 10, 2026
Install
$ npx -y skills add telagod/code-abyss --skill verifying-modules --agent claude-codeInstalls into .claude/skills of the current project.
Files
模块完整性校验关卡
文档不齐不算交付。模块是否能被外人独立理解，是「完成」的最低门槛。
何时使用
| 场景 | 跑 | 理由 |
|---|---|---|
| 新建模块 | ✅ 必跑 | 阻断「无文档落地」 |
| 模块重构（边界变化） | ✅ | 文档随边界更新 |
| 接收他人模块 | ✅ | 检查可理解性 |
| 提交前（涉及模块新增） | ✅ | 最后闸 |
| 仅函数级修改 | ❌ | 走 analyzing-changes 即可 |
必备文件
| 文件 | 缺失后果 | 备注 |
|---|---|---|
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 生成骨架，再人工填决策
- 通过后 → 串 analyzing-security 扫新增攻击面
- 大改后 → 串 analyzing-changes 看辐射面
使用
Sponsors
Promote your product hereReach 125k+ visitors monthlyPromote your product hereReach 125k+ visitors monthly
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any language
Agent CaffeineSponsoredClose your lid, come back to finished workSnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthlyWaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthlyknobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/telagod/code-abyss
- Categories
- Documentation, Design & UI/UX
- License
- MIT
- First seen
- Jun 11, 2026
More from telagod/code-abyss
All 30- Analyzing Changes
- Analyzing Security
- Analyzing Spreadsheets
- Applying Ui Design System
- Architecting Security
- Automating Devops
- Building Agent Systems
- Checking Code Quality
- Creating Presentations
- Cultivating Personas
- Cultivating Skills
- Defending Applications
- Designing Architectures
- Designing Hardware Products
- Detecting And Responding
- Developing Mobile Apps
- Developing Software
- Engineering Data Pipelines
- Generating Docs
- Indexing Code
- Operating Kicad Eda
- Orchestrating Adversarial Reviews
- Processing Docx
- Processing Pdfs
Recommended
More Documentation1
deepchat-sdd-cleanupThinkInAIXYZ/deepchatUse only when a developer explicitly asks to clean, prune, tidy, or organize DeepChat SDD documentation after implementation and validation. Scans docs/features0skills.sh installs
deepchat-sdd-cleanupThinkInAIXYZ/deepchatUse only when a developer explicitly asks to clean, prune, tidy, or organize DeepChat SDD documentation after implementation and validation. Scans docs/features0skills.sh installs2
deepchat-sddthinkinaixyz/deepchatUse for any DeepChat code, configuration, documentation, feature, issue fix, refactor, or architecture change before implementation. This skill enforces the pro0skills.sh installs
deepchat-sddthinkinaixyz/deepchatUse for any DeepChat code, configuration, documentation, feature, issue fix, refactor, or architecture change before implementation. This skill enforces the pro0skills.sh installs3
figma-generate-designfigma/mcp-server-guideUse this skill alongside figma-use when the task involves translating an application page, view, or multi-section layout into Figma. Triggers: 'write to Figma',6.4Kskills.sh installs
figma-generate-designfigma/mcp-server-guideUse this skill alongside figma-use when the task involves translating an application page, view, or multi-section layout into Figma. Triggers: 'write to Figma',6.4Kskills.sh installs4implement-designfigma/mcp-server-guideTranslates Figma designs into production-ready code with 1:1 visual fidelity. Use when implementing UI from Figma files, when user mentions "implement design", 5.9Kskills.sh installs
implement-designfigma/mcp-server-guideTranslates Figma designs into production-ready code with 1:1 visual fidelity. Use when implementing UI from Figma files, when user mentions "implement design", 5.9Kskills.sh installs5figma-generate-libraryfigma/mcp-server-guideBuild or update a professional-grade design system in Figma from a codebase. Use when the user wants to create variables/tokens, build component libraries, crea4.7Kskills.sh installs
figma-generate-libraryfigma/mcp-server-guideBuild or update a professional-grade design system in Figma from a codebase. Use when the user wants to create variables/tokens, build component libraries, crea4.7Kskills.sh installs6
latex-thesis-zhbahayonghang/academic-writing-skills中文 LaTeX 学位论文助手，面向已有 .tex 硕博论文工程：编译诊断、GB/T 7714、模板识别、结构/格式/公式断行、术语一致性、逻辑与文献综述、标题优化、去 AI 味、盲审隐匿、对照学校规范逐项终检。触发词：学位论文/毕业论文/硕士/博士论文。英文论文用 latex-paper-en，审稿总评用 paper4.3Kskills.sh installs
latex-thesis-zhbahayonghang/academic-writing-skills中文 LaTeX 学位论文助手，面向已有 .tex 硕博论文工程：编译诊断、GB/T 7714、模板识别、结构/格式/公式断行、术语一致性、逻辑与文献综述、标题优化、去 AI 味、盲审隐匿、对照学校规范逐项终检。触发词：学位论文/毕业论文/硕士/博士论文。英文论文用 latex-paper-en，审稿总评用 paper4.3Kskills.sh installs