Reference Builder

What it does

The Reference Builder skill assists in creating comprehensive and well-structured technical reference documentation. It focuses on generating detailed API references, configuration guides, and schema documentation, ensuring accuracy and completeness for research or development purposes. The tool provides guidance, best practices, and checklists to streamline the reference building process and produce a definitive source of truth.

When to use it

• When working on reference builder tasks or workflows.
• When needing guidance, best practices, or checklists for creating technical references.
• For generating API references including method signatures, return types, error handling, and rate limits.
• To create configuration guides detailing parameters, default values, and dependencies.

Key capabilities

• Exhaustive Coverage: Documents all parameters, methods, and configuration options.
• Precise Categorization: Organizes information for quick retrieval.
• Cross-Referencing: Links related concepts and dependencies within the documentation.
• Example Generation: Provides examples for every documented feature.
• Edge Case Documentation: Covers limits, constraints, and special cases.
• Structured Entry Format: Uses a defined format including type, default value, required status, versioning information, descriptions, parameters, return types, exceptions, and example code.
• Hierarchical Content Organization: Includes Overview, Quick Reference, Detailed Reference, Advanced Topics, and Appendices sections.

Example prompts

• "Generate a reference entry for the calculate_average method, including its parameters, return type, and potential error codes."
• "Create a configuration guide section detailing the valid ranges for the 'timeout' parameter."
• “Show me an example of how to document schema relationships and foreign keys.”

Tips & gotchas

• Clarify goals, constraints, and required inputs before starting.
• Refer to resources/implementation-playbook.md for detailed examples and implementation guidance.
• This skill is specifically designed for reference building tasks; it's not suitable for unrelated tasks or integrating external tools.