verify-module

Validate software module directory structures and documentation completeness.

5.8k|441|Updated Jan 4, 2026

Search Tags:#design document #code integrity #module validation #structural audit #documentation check #readme check

Ready to run

npx skills add https://github.com/fengshao1227/ccg-workflow --skill verify-module

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: verify-module
Source: https://github.com/fengshao1227/ccg-workflow/tree/main/templates/skills/tools/verify-module
Command: npx skills add https://github.com/fengshao1227/ccg-workflow --skill verify-module

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that software modules are complete and well-documented, preventing delivery blockers caused by missing essential files like README.md or DESIGN.md, and verifying code-documentation synchronization.

Core Features & Use Cases

Directory Structure Validation: Checks for the presence of required files and recommended directories.
Documentation Completeness Check: Verifies that README.md and DESIGN.md contain essential information.
Code-Documentation Sync: Helps ensure that code and its documentation are up-to-date.
Use Case: Automatically run this skill after creating a new module to confirm it meets all documentation and structural standards before proceeding with development or integration.

Quick Start

Run the module scanner script on the 'my-new-module' directory with verbose output.

Frequently Asked Questions about verify-module

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

FAQPage Schema

How do I validate module integrity and check for missing documentation in a software project?▼

To validate module integrity, you can scan the directory structure to detect missing documentation and enforce the presence of README.md and DESIGN.md. This process checks for required files and verifies code-documentation synchronization.

What is a structural audit for software modules and when do I need to run one?▼

A structural audit for software modules is a validation process that checks directory structures and verifies the presence of essential files like README.md and DESIGN.md. You should run it after creating a new module to confirm compliance before integration.

How do I verify code-documentation synchronization and ensure README completeness?▼

You verify code-documentation synchronization by scanning the module directory to confirm that README.md and DESIGN.md contain essential information and match the source code and test files. This provides a detailed report on compliance.

Can I run a directory structure validation on an existing module to find missing files?▼

Yes, you can run a directory structure validation on an existing module to check for the presence of required files and recommended directories. The scanner detects missing documentation and provides detailed reports on compliance.

What are the limitations of automated module validation for design documents and code?▼

Automated module validation is limited to scanning directory structures, detecting missing documentation like README.md and DESIGN.md, and verifying code-documentation synchronization. It does not evaluate the technical accuracy or quality of the written content.