Generate Comprehensive Technical Documentation
A skill for creating exhaustive, precisely organized technical reference documentation - APIs, configs, and schemas.
Why it matters
Automate the creation of detailed and accurate technical reference documentation, including API references, configuration guides, and schema documentation, ensuring exhaustive coverage and precise organization.
Outcomes
What it gets done
Document all parameters, methods, and configuration options.
Generate code examples for every documented feature.
Organize documentation hierarchically with navigation aids.
Ensure documentation accuracy, consistency, and searchability.
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/ag-reference-builder | bash Overview
Reference Builder
Builds exhaustive technical reference documentation - API references, configuration guides, and schema docs - in a consistent, cross-referenced entry format. Use it when producing definitive reference documentation for an API, configuration surface, or schema; not for tutorials or introductory guides.
What it does
This skill acts as a reference documentation specialist, creating comprehensive, searchable, and precisely organized technical references meant to serve as the definitive source of truth. Its core capabilities are exhaustive coverage of every parameter, method, and configuration option, precise categorization for quick retrieval, cross-referencing between related concepts, example generation for every documented feature, and explicit documentation of edge cases, limits, and constraints.
It handles three reference documentation types: API references (complete method signatures, return types, error codes, rate limits, and authentication requirements), configuration guides (every configurable parameter, default values and valid ranges, environment-specific settings, and migration paths for deprecated options), and schema documentation (field types and constraints, validation rules, relationships, indexes, and versioning). Every documented entry follows a consistent format:
### [Feature/Method/Parameter Name]
**Type**: [Data type or signature]
**Default**: [Default value if applicable]
**Required**: [Yes/No]
**Since**: [Version introduced]
**Deprecated**: [Version if deprecated]
**Description**:
[Comprehensive description of purpose and behavior]
**Parameters**:
- `paramName` (type): Description [constraints]
**Returns**:
[Return type and description]
**Throws**:
- `ExceptionType`: When this occurs
**Examples**:
[Multiple examples showing different use cases]
**See Also**:
- [Related Feature 1]
- [Related Feature 2]
Content is organized hierarchically - overview, quick reference cheat sheet, detailed alphabetical or logical reference, advanced topics, and appendices (glossary, error codes, deprecations) - with navigation aids like a deep-linked table of contents, alphabetical index, and category grouping. Code examples progress from a minimal working example through a common use case, advanced configuration, error handling, and a performance-optimized version. Warnings, notes, tips, deprecation guidance, and security implications are called out with dedicated markers.
The build process runs in six steps: inventory every public interface, extract documentation from code, enhance with examples and context, validate accuracy and completeness, organize for optimal retrieval, and cross-reference related concepts. Output is primarily Markdown (clean structure, syntax highlighting, tables, cross-reference links), optionally paired with machine-readable metadata like JSON schemas or OpenAPI specifications.
When to use - and when NOT to
Use this skill when working on reference builder tasks or workflows, or when you need guidance, best practices, or checklists for building technical reference documentation.
Do not use it for tasks unrelated to reference documentation or that need a different domain or tool outside this scope.
Inputs and outputs
Inputs are the public interfaces, configuration options, or schemas to document. Output is structured Markdown reference documentation following the standard entry format, organized hierarchically with navigation aids and cross-references. Quality standards enforced: completeness (every public interface documented), accuracy (verified against actual implementation), consistency (uniform formatting and terminology), searchability (explicit keywords and aliases), and maintainability (clear versioning).
Who it's for
Technical writers and developers producing API, configuration, or schema reference documentation who need every interface exhaustively and consistently documented rather than an introductory guide or tutorial.
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.