What problem does it solve?
Many codebases lack clear, maintainable explanations of domain logic, integration points, and non-obvious decisions, which slows onboarding and increases bugs; this Skill provides brief, high-value documentation and inline comments targeted at the "why" rather than the obvious "what."
Core Features & Use Cases
- Inline Commenting: Add concise, one- to three-line comments explaining business rules, edge cases, and performance/security considerations without changing code behavior.
- External Documentation Generation: Produce structured markdown (README, architecture, module overviews, API contracts, glossary) by scanning directories and identifying key modules and data flows.
- Clarification Protocol & Output Summary: Always ask mandatory scope and mode questions before editing and produce a Documentation Summary that lists files changed, coverage, and recommendations.
- Use Case: Triage a legacy auth module by adding targeted inline comments to unusual validation logic and generate an auth/overview.md that describes flows and dependencies.
Quick Start
Document src/auth/login.py inline focusing on domain logic and add concise comments for non-obvious logic.