reference-docs

What problem does it solve?

This Skill provides a standardized, structured approach to writing technical documentation, ensuring consistency, clarity, and completeness for API references, parameter tables, and symbol documentation.

Core Features & Use Cases

• Structured Templates: Offers a clear Markdown template for API and symbol documentation, including sections for parameters, returns, errors, and examples.
• Writing Principles: Enforces best practices like brevity, scannability, and runnable examples.
• Use Case: When documenting a new API endpoint, use this Skill's template to ensure all necessary details like parameters, expected responses, and error codes are clearly and consistently presented.

Quick Start

Use the reference-docs skill to generate a template for documenting a new API endpoint.