skills.rest
wzyxdwll
wzyxdwllCOMMUNITY
Explore all skills by this author →
GitHub

verify-module

Scan software modules for missing documentation and structural gaps.

14|1|Updated May 6, 2026
Search Tags:#documentation#validation#repository#code-quality#module#scanning#checks
One-click install
npx skills add https://github.com/wzyxdwll/ccgx-workflow --skill verify-module-wzyxdwll
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: verify-module
Source: https://github.com/wzyxdwll/ccgx-workflow/tree/main/templates/skills/tools/verify-module
Command: npx skills add https://github.com/wzyxdwll/ccgx-workflow --skill verify-module-wzyxdwll

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Module integrity is critical for stable deployments. This skill streamlines verification by scanning a module's structure to detect missing documentation and misaligned design decisions, preventing integration of incomplete components.

Core Features & Use Cases

  • Automated documentation checks: verify presence of README.md and DESIGN.md, and ensure essential documentation is present.
  • Structure conformance: check for a sensible project layout (code, tests, and design docs) and report deviations.
  • Automated scanning results: produce a structured report highlighting errors, warnings, and guidance for remediation.

Quick Start

Run the module_scanner.js script in the target module directory to generate a human-readable report or JSON output.

Frequently Asked Questions about verify-module

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

FAQPage Schema
How do I check a code module for missing README and DESIGN documentation?▼

Checking a code module for missing documentation involves scanning the repository structure to verify the presence of README.md and DESIGN.md files. This automated process detects structural gaps, reporting errors and warnings for remediation.

What is automated module integrity scanning and when do I need it?▼

Automated module integrity scanning validates a software module's structure and essential documents. You need it before integrating components to prevent incomplete modules from compromising deployment stability.

How do I validate project structure and test directory conformance in a repository?▼

Validating project structure and test directory conformance involves running an automated scanner in the target module directory. It checks for a sensible layout including code, tests, and design docs, then reports any structural deviations found.

Does module verification require any external dependencies to run?▼

Module verification does not require external dependencies to run. It operates as a standalone script within the target repository directory to produce a structured integrity report without needing additional software components.

What is the best way to generate a report of errors and warnings for code quality checks?▼

The best way to generate a report of errors and warnings for code quality checks is executing an automated module scan. It produces a structured output detailing structural conformance issues and providing remediation guidance.

Related Skills

Explore More Software Engineering Skills→
jvalinskyjvalinsky

objc-test-gap-mapper

Identify Objective-C source modules lacking corresponding test files by comparing basenames and directory structures.

Community
Intermediate
telagodtelagod
238

verify-module

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

Community
Advanced
onbjergonbjerg
4

rust

Format and lint Rust code with cargo fmt and cargo clippy.

Community
Intermediate
CatsofsufferingCatsofsuffering
5

verify-module

Scan module directories to validate documentation presence and structural integrity.

Community
Intermediate