verify-module

Scan module directories to detect missing docs and code-documentation mismatches.

238|30|Updated Feb 2, 2026
One-click install
npx skills add https://github.com/telagod/code-abyss --skill verify-module-telagod
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: verify-module
Source: https://github.com/telagod/code-abyss/tree/main/skills/tools/verify-module
Command: npx skills add https://github.com/telagod/code-abyss --skill verify-module-telagod

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This tool automates the verification of module integrity by scanning directory structures, ensuring essential documentation exists, and validating alignment between code and docs.

Core Features & Use Cases

  • Automatic structure validation: checks for module/README.md and module/DESIGN.md presence and reasonable content.
  • Doc-code consistency: detects mismatches between code layout and documentation.
  • Before-merge guard: recommended for new module creation, refactoring, or pre-submission checks.

Quick Start

Run the verify-module scanner on a target module path to begin validation.

Frequently Asked Questions about verify-module

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check module integrity and ensure README and DESIGN docs are present?

To check module integrity, run a scanner across the target directory structure to enforce the presence of module/README.md and module/DESIGN.md, validating code layout and flagging missing documentation or structural anomalies for remediation.

How do I detect mismatches between code layout and documentation?

You detect mismatches between code and documentation by applying a validation scanner to the module path, which automatically identifies and reports gaps between the actual code layout and the content within README.md and DESIGN.md files.

What is module structure validation and when do I need it?

Module structure validation is the process of scanning directory structures to ensure essential documentation exists and aligns with the code. You need it when creating new modules, refactoring existing ones, or running pre-submission checks.

Can I use an automated scanner as a pre-merge guard for module documentation?

Yes, you can use this scanner as a pre-merge guard to automatically validate module integrity, ensuring that required documentation like README.md and DESIGN.md exists and matches the code layout before submitting changes.

What is the best way to identify missing documentation in a directory structure?

The best way to identify missing documentation is to run an automated scanner on the target module path, which enforces the presence of README.md and DESIGN.md files and reports any missing docs or structural anomalies found during the scan.