What problem does it solve? Codebases accumulate undocumented functions, types, and endpoints that no one can trace back to a requirement, making reviews, onboarding, and audits painful. This Skill enforces documentation at the moment of writing — never as a cleanup step — so every public construct carries a one-line summary, parameters, return values, error conditions, and mandatory @spec_id / @req_id traceability tags. ## Core Features & Use Cases - Six-tier construct taxonomy: Defines exact documentation requirements for callables, type definitions, module boundaries, external endpoints, exported values, and test units, each with required fields and per-language examples. - Spec/requirement traceability: Every construct must carry @spec_id SPEC-N and @req_id REQ-NNN (or @validates_req for tests), with an Iron Law that nothing exists in the codebase without a spec. - Language-agnostic annotation reference: Covers TypeScript, Python, Go, Rust, Java, Kotlin, C/C++, Swift, Ruby, and PHP with the correct doc-comment style per language, plus lifecycle tags like @deprecated, @since, and thread-safety notes. - Use Case: While implementing a new POST /api/v1/auth/login handler, the Skill ensures you document auth requirements, request/response schemas, side effects, and link the endpoint to SPEC-1 / REQ-001 before marking the work complete. ## Quick Start Ask the AI to apply the code-documentation rules to document the public functions and types in the file you just wrote, adding spec_id and req_id tags to each construct.
