document-module - Document a module’s behavior, structure, and problems
Build or maintain living documentation for a module or service, including scope, cross-stack behaviors, landmarks, glossary terms, and a stable problem registry.
Tags
Updated: 2026-10-04Capabilities
Typical Inputs
Typical Outputs
What this skill does
- Build module documentation
- Recheck documentation drift
- Record behavior landmarks
- Register stable problem IDs
- Scan and reconcile code
- Document domain FE flows
- Detect ownership conflicts
- Cross-link module boundaries
- Seed missing glossary terms
Inputs
- Module area
- Source code repositories
- Existing module documentation
- User rebuild instruction
- Supporting template files
Outputs
- Module index.md
- Problem registry
- Glossary updates
- Architecture documentation
- Cross-module links
- Boundary conflict flags
Requirements
- Git repository
- Repository file access
- Documentation file access