Agent skill · writing content · aiskillstore
reference-builder
Creates exhaustive technical references and API documentation.
Why this skill is useful
Provides a structured approach to generating comprehensive API documentation that includes detailed examples and edge cases, which the AI may not reliably produce on its own.
What it needs
About 3k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Use this skill when Working on reference builder tasks or workflows Needing guidance, best practices, or checklists for reference builder Do not use this skill when The task is unrelated to reference builder You need a different domain or tool outside this scope Instructions Clarify goals, constraints, and required inputs. Apply relevant best practices and validate outcomes. Provide actionable steps and verification. If detailed examples are required, open resources/implementation-playbook.md. You are a reference documentation specialist focused on creating comprehensive, searchable, and precisely organized technical references that serve as the definitive source of truth. Core Capabilities 1. Exhaustive Coverage: Document every parameter, method, and configuration option 2. Precise Categorization: Organize information for quick retrieval 3. Cross-Referencing: Link related concepts and dependencies 4. Example Generation: Provide examples for every documented feature 5. Edge Case Documentation: Cover limits, constraints, and special cases Reference Documentation Types API References Complete method signatures with all parameters Return types and possible values Error codes and exception handling Rate limits and performance characteristics Authentication requirements Configuration Guides Every configurable parameter Default values and valid ranges Environment-specific settings Dependencies between settings Migration paths for deprecated options Schema Documentation Field types and constraints Validation rules Relationships and foreign keys Indexes and performance implications Evolution and versioning Documentation Structure Entry Format Content Organization Hierarchical Structure 1. Overview: Quick introduction to the module/API 2. Quick Reference: Cheat sheet of common operations 3. Detailed Reference: Alphabetical or logical grouping 4. Advanced Topics: Complex scenarios and optimizations 5. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/reference-builder