Verifying Modules logo

Verifying Modules

Community
telagod
verifying-modules

Scans directory structure, detects missing documentation, and verifies code-doc synchronization. Use when checking module completeness, README presence, or DESIGN.md alignment. Automatically triggered after creating new modules.

Overview

Publishertelagod
Repositorycode-abyss
Skill nameverifying-modules
Stars
242
Forks
33
Bundled files
2
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 2 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by telagod on GitHub. Read the source before you install it.

Installation

Install the Verifying Modules AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/telagod/code-abyss/tree/main/skills/verifying-modules
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/telagod/code-abyss.git /tmp/code-abyss
mkdir -p .claude/skills
cp -r /tmp/code-abyss/skills/verifying-modules .claude/skills/verifying-modules
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Verifying Modules in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Verifying Modules on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Verifying Modules is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

模块完整性校验关卡

文档不齐不算交付。模块是否能被外人独立理解,是「完成」的最低门槛。

何时使用

场景跑理由
新建模块✅ 必跑阻断「无文档落地」
模块重构(边界变化)✅文档随边界更新
接收他人模块✅检查可理解性
提交前(涉及模块新增)✅最后闸
仅函数级修改❌走 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 联动

使用

bash
node scripts/module_scanner.js <模块路径>
node scripts/module_scanner.js <模块路径> -v       # 详细
node scripts/module_scanner.js <模块路径> --json   # CI 用

收口

阻断项必修。警告项可在 DESIGN 留「不写测试的理由」(如纯接口声明、纯常量)。「以后补」不算理由。

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Verifying Modules AI skill do?

Scans directory structure, detects missing documentation, and verifies code-doc synchronization. Use when checking module completeness, README presence, or DESIGN.md alignment. Automatically triggered after creating new modules.

Why use Verifying Modules on TypingMind?

Because you install it once and use it with any model. Verifying Modules is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Verifying Modules in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/telagod/code-abyss/tree/main/skills/verifying-modules. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Verifying Modules?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Verifying Modules?

As many as you like. As long as a model supports skills, you can use Verifying Modules with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Verifying Modules AI skill free?

Yes. It is published on GitHub by telagod under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇