briefkit-documenter

What problem does it solve?

This Skill solves the problem of outdated, inconsistent, or agent-unfriendly documentation by automating the creation and validation of structured, interface-first module documentation. It ensures your documentation is always current and useful for both humans and AI.

Core Features & Use Cases

• Interface-First Documentation Generation: Automatically create BRIEF.md files that prioritize external behavior (inputs, outputs, contracts) over internal implementation details.
• PRD/Specification Conversion: Transform product requirements documents (PRDs) or technical specifications into structured, agent-friendly module briefs, ensuring alignment between product vision and code.
• Automated Documentation Validation: Validate existing or newly generated documentation against the strict rules of the BRIEF System v3 specification, catching errors and inconsistencies early in the development cycle.
• Use Case: You're starting a new module and need to quickly establish its purpose, interface contract, and dependencies. This skill can analyze your code and scaffold a BRIEF.md file, marking inferred sections for your review, ensuring a consistent documentation standard from day one.

Quick Start

To generate a BRIEF.md for a new module:

1. Analyze the module's code and boundaries.
2. Generate a BRIEF.md file with all required sections.
3. Mark any uncertain content with INFERRED.
4. Validate the generated BRIEF against the rules.
5. Request human review for inferred content.