Module Integrity & Documentation Verifier
Scans directory structures to ensure complete documentation and architectural alignment for software modules.
This skill acts as a quality assurance gate for software development, ensuring that code modules are not considered 'complete' until they are fully documented and architecturally sound. It automatically scans for mandatory files like README.md and DESIGN.md, verifies the synchronization between implementation and design specifications, and enforces standards for module boundaries. By catching 'documentation debt' early, it ensures that every part of your codebase remains maintainable, understandable, and ready for handoff or integration.
Características Principales
01Integration with documentation generators to bootstrap missing file structures
02228 GitHub stars
03Mandatory DESIGN.md validation to capture architectural decisions and trade-offs
04Smart exemption logic for generated code, private utilities, and data modules
05Verification of README content including usage examples and dependency maps
06Automated directory scanning for missing mandatory documentation files
Casos de Uso
01Verifying documentation accuracy after major refactors or boundary changes
02Auditing third-party or legacy modules for architectural clarity
03Ensuring new modules meet the 'Definition of Done' before delivery