writing-reference-docs

What problem does it solve?

This Skill streamlines the creation of precise and comprehensive reference documentation for technical components, ensuring clarity and consistency for users.

Core Features & Use Cases

• API Documentation: Generate detailed specs for endpoints, parameters, and responses.
• Configuration Guides: Document settings, options, and their valid values.
• Code Reference: Create clear descriptions for functions, methods, and types.
• Use Case: You need to document a new REST API endpoint. Use this Skill to generate a markdown file detailing the endpoint, its parameters, request/response formats, and error codes, adhering to established patterns.

Quick Start

Use the writing-reference-docs skill to generate documentation for the getUser API endpoint.