Agent skill

Verifying Modules

by telagod in telagod/code-abyss

Scans directory structure, detects missing documentation, and verifies code-doc synchronization.

MITAuto-check: notesDevelopment

Install Verifying Modules

skills CLI
$ npx skills add telagod/code-abyss --skill verifying-modules -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install telagod/code-abyss verifying-modules --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/telagod/code-abyss.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/verifying-modules .claude/skills/verifying-modules && rm -rf skills-src

Use ~/.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/

Facts

Skill name
verifying-modules
GitHub stars
243
Token cost
~431 tokens
SKILL.md length
89 words
Files
3 (incl. scripts)
Skills in repo
38
Repo updated
First seen
Licence
MIT

At a glance

Scans directory structure, detects missing documentation, and verifies code-doc synchronization.

  • Checking module completeness
  • SKILL.md covers 何时使用, 必备文件, 文档要求 and 何时豁免, plus 3 more sections
  • Runs JavaScript scripts from its folder; calls node
  • README presence

What it does

Verifying Modules is an agent skill from telagod/code-abyss. 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.

Its SKILL.md is about 430 tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including scripts (for example `agents/openai.yaml` and `scripts/module_scanner.js`). Compatibility notes: node=18

It sits in Development, covering Design tokens and Technical documentation. The repository describes itself as: Give your AI coding agent a personality. Composable persona + style + skills for Claude Code, Codex, Gemini CLI & OpenClaw. Ships Tech Persona Card v1.0 spec. The licence is MIT.

When your agent uses it

  • Checking module completeness
  • README presence
  • DESIGN.md alignment

Example prompts

  • “Use the verifying-modules skill to scan directory structure, detects missing documentation, and verifies code-doc synchronization”
  • “/verifying-modules”

Requirements

  • Node.js
  • 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 2544577. 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:

    • Bash
    • Read
    • Glob

    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

Verifying Modules loads about 431 tokens when it runs. Until then it costs about 62 tokens; SKILL.md has 89 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~62
When it runs · the whole SKILL.md, loaded when a task matches
~431

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 telagod/code-abyss at commit 2544577, republished under its MIT licence (© telagod). 89 words, ~431 tokens.

Download SKILL.mdSave it as .claude/skills/verifying-modules/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
verifying-modules
description
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.
allowed-tools
Bash, Read, Glob
compatibility
node>=18
user-invocable
false
argument-hint
<模块路径>

模块完整性校验关卡

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

何时使用

场景跑理由
新建模块✅ 必跑阻断「无文档落地」
模块重构(边界变化)✅文档随边界更新
接收他人模块✅检查可理解性
提交前(涉及模块新增)✅最后闸
仅函数级修改❌走 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 留「不写测试的理由」(如纯接口声明、纯常量)。「以后补」不算理由。

© telagod, 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 2 other files (scripts) in skills/verifying-modules of telagod/code-abyss.

  • SKILL.md
  • agents/openai.yaml
  • scripts/module_scanner.js

Open the folder on GitHubat commit 2544577

Compare with similar skills

Verifying Modules 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.

Verifying Modules compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Verifying Modules this skilltelagod/code-abyss243—~431Automated safety check: NotesMIT
Moonbit Docs Maintainermoonbitlang/moonbit-docs2.4k—~1.1kAutomated safety check: PassCustom licence
DESIGN.md Creatoribelick/ui-skills9.5k—~4kAutomated safety check: PassMIT
Orchardcore Docs WriterOrchardCMS/OrchardCore8.2k—~1.1kAutomated safety check: PassBSD-3-Clause
Chisle AuditJayPokale/Chisle633—~687Automated safety check: PassMIT
Domodomo New Tool Workflowdarknecrocities/DomoDomo---All-in-one-Tool239—~1.3kAutomated safety check: PassNone

Similar skills

  • Moonbit Docs Maintainer

    moonbitlang/moonbit-docs

    A skill your agent uses when maintaining the moonbitlang/moonbit-docs repository, including Sphinx docs under next/, MoonBit examples under next/sources/, error-code documentation, gettext…

    2.4k GitHub stars~1.1k tokensUpdated 17 days ago
    DevelopmentAuto-check passed
  • DESIGN.md Creator

    ibelick/ui-skills

    Writes or updates a DESIGN.md for one product from its repository or a public URL, recording the design language and tokens that the evidence supports.

    9.5k GitHub stars~4k tokensUpdated today
    Frontend & DesignAuto-check passed
  • Orchardcore Docs Writer

    OrchardCMS/OrchardCore

    Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects.

    8.2k GitHub stars~1.1k tokensUpdated today
    DevelopmentAuto-check passed
  • Chisle Audit

    JayPokale/Chisle

    One-shot efficiency audit of a file, diff, or whole repo across BOTH axes at once: over-engineered code (reinvented stdlib, needless abstractions, speculative config) AND bloated prose (verbose…

    633 GitHub stars~687 tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Domodomo New Tool Workflow

    darknecrocities/DomoDomo---All-in-one-Tool

    Mandatory end-to-end procedure for adding or materially changing a DomoDomo tool or category.

    239 GitHub stars~1.3k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Design Tracker

    DeL-TaiseiOzaki/claude-code-orchestra

    Record a project design decision into .claude/docs/DESIGN.md through the shared typed writer.

    199 GitHub stars~2k tokensUpdated 17 days ago
    DevelopmentAuto-check passed

More from telagod/code-abyss

All 38 skills in this repo
  • Security Gate Scanner

    telagod/code-abyss

    Scans code with a bundled Node scanner for injection, secret leaks and other dangerous patterns, and requires documented decisions for accepted risks.

    243 GitHub stars~552 tokensUpdated 2 mo ago
    Auto-check: notes
  • Persona Voice Card Builder

    telagod/code-abyss

    Distills a recurring agent voice from conversations into a restricted Persona Voice Card, validates it for schema, safety and distinctness, and prepares it for community submission.

    243 GitHub stars~716 tokensUpdated 2 mo ago
    Auto-check: notes
  • Skill Cultivation Funnel

    telagod/code-abyss

    Distills repeated workflows into new skills, improves existing ones and promotes them through local, project and community tiers after a default-deny safety scan.

    243 GitHub stars~794 tokensUpdated 2 mo ago
    Auto-check: notes
  • DOCX Processing Toolkit

    telagod/code-abyss

    Routes Word document tasks to the right tool: pandoc for text, raw OOXML for structure and comments, docx-js for new files, and a mandatory redlining flow for edits to others' documents.

    243 GitHub stars~668 tokensUpdated 2 mo ago
    Auto-check: notes
  • PDF Processing Toolkit

    telagod/code-abyss

    Picks the right Python library or CLI tool for a PDF task, text and table extraction, merging, splitting, OCR, watermarking or form filling, and points to a matching recipe.

    243 GitHub stars~532 tokensUpdated 2 mo ago
    Auto-check: notes
  • Code Change Analysis Gate

    telagod/code-abyss

    Checks what a code change touched, how far its impact reaches and whether design docs, tests and README files kept up, before commit or in review.

    243 GitHub stars~532 tokensUpdated 2 mo ago
    Auto-check: notes

Questions about Verifying Modules

What does Verifying Modules do?

Scans directory structure, detects missing documentation, and verifies code-doc synchronization. Verifying Modules is an agent skill from telagod/code-abyss. Scans directory structure, detects missing documentation, and verifies code-doc synchronization.

When should I use Verifying Modules?

Verifying Modules fits situations like: checking module completeness; README presence; DESIGN.md alignment.

How do I install Verifying Modules in Claude Code?

Run `npx skills add telagod/code-abyss --skill verifying-modules -a claude-code`. Or copy the skill folder (skills/verifying-modules in telagod/code-abyss) into .claude/skills/verifying-modules in your project. Claude Code loads it when a task matches its description.

How do I install Verifying Modules in Codex?

Run `npx skills add telagod/code-abyss --skill verifying-modules -a codex`. Or copy the skill folder (skills/verifying-modules in telagod/code-abyss) into .agents/skills/verifying-modules in your project. Codex loads it when a task matches its description.

Can I use Verifying Modules 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 telagod/code-abyss --skill verifying-modules -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/verifying-modules, .gemini/skills/verifying-modules, .github/skills/verifying-modules and .opencode/skills/verifying-modules in your project.

What does Verifying Modules need to run?

Going by SKILL.md and its folder, Verifying Modules needs JavaScript for the scripts in its folder and the command-line tools its instructions call (node). Our summary lists: Node.js. Its frontmatter pre-approves these tools: Bash, Read, Glob. Compatibility (from SKILL.md): node>=18.

Does Verifying Modules 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 Verifying Modules 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 Verifying Modules use?

Verifying Modules is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Verifying Modules use?

About 431 tokens (SKILL.md is roughly 1.7k 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 Verifying Modules?

Skills that share tags, products or a category with Verifying Modules: Moonbit Docs Maintainer (moonbitlang/moonbit-docs, 2.4k stars), DESIGN.md Creator (ibelick/ui-skills, 9.5k stars), Orchardcore Docs Writer (OrchardCMS/OrchardCore, 8.2k stars) and Chisle Audit (JayPokale/Chisle, 633 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Verifying Modules?

telagod (a GitHub user) maintains it in telagod/code-abyss, which has 243 GitHub stars. The repository holds 38 skills in this directory. The repository was last updated on July 19, 2026.

Source: telagod/code-abyss on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.