reference-docs

Generate standardized Markdown templates for API and symbol documentation.

Updated Feb 18, 2026
One-click install
npx skills add https://github.com/riddopic/cc-tools --skill reference-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reference-docs
Source: https://github.com/riddopic/cc-tools/tree/main/.claude/skills/reference-docs
Command: npx skills add https://github.com/riddopic/cc-tools --skill reference-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about reference-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write standardized technical documentation for an API reference?

To write standardized technical documentation, use a structured Markdown template that enforces clear parameter tables, return values, error codes, and runnable examples for API references.

What is the best way to format parameter tables and symbol documentation?

The best way to format parameter tables and symbol documentation is applying standardized Markdown templates that enforce brevity, scannability, and complete definitions for parameters and returns.

How do I generate a consistent Markdown template for documenting software APIs?

You generate a consistent Markdown template for software APIs by applying predefined structural sections for parameters, expected responses, and examples, ensuring all necessary technical details are clearly presented.

Does this approach work for generating GoDoc style symbol documentation?

Yes, this approach works for generating symbol documentation by enforcing precise, scannable, and complete formatting principles that satisfy the strict consistency requirements of technical writing workflows.

When do I need a standardized template for technical writing?

You need a standardized template for technical writing when documenting new API endpoints or software symbols to ensure consistent formatting, clear parameter definitions, and complete runnable examples across engineering teams.

What are the limitations of using predefined templates for API documentation?

Predefined templates for API documentation enforce strict formatting and scannability, which may limit flexibility but guarantees structural completeness for parameters, returns, errors, and runnable examples.