writing-skills

Test-driven documentation applies RED-GREEN-REFACTOR cycles to process workflows by running baseline tests without the Skill, implementing minimal documentation, then verifying and refining to close loopholes. This ensures consistency and repeatable quality standards across documentation libraries.

Progressive disclosure in technical documentation means keeping inline content concise while linking to optional scripts, references, and assets only when needed. This modular approach prevents overwhelming readers while still providing deeper context on demand.

You validate Skill readiness before deployment by using deployment checklists and example patterns to verify effectiveness. This includes confirming YAML frontmatter contains required name and description fields and checking test coverage through RED-GREEN-REFACTOR cycles.

Yes, this test-driven approach enforces YAML frontmatter with name and description fields for reliable discovery. Structured frontmatter ensures each piece of documentation can be consistently identified and indexed across Skill libraries.

The best way to structure modular documentation is through progressive disclosure: keep core content inline and link optional scripts, references, and assets only when needed. This maintains readability while supporting deeper technical context for advanced users.

A test-driven approach to documentation may not suit simple, static content with no repeatable process to verify. It is designed for Skills requiring iterative refinement, rationalization tracking, and quality enforcement through structured RED-GREEN-REFACTOR cycles.