Reference Documentation Patterns
Generates structured, scannable technical reference documentation for APIs, functions, and symbols.
The Reference Documentation Patterns skill streamlines the creation of information-oriented technical documentation, helping developers produce consistent and precise API references. It provides standardized templates for parameter tables, return values, and runnable code examples, ensuring that technical specifications are easy to scan and use for experienced users. By enforcing a 'lookup-first' philosophy, it eliminates fluff and focuses on factual accuracy and completeness for functions, HTTP endpoints, and UI components.
主な機能
0164 GitHub stars
02Standardized templates for API and symbol documentation
03Auto-formatting for parameter, return, and error tables
04Guidelines for creating runnable, context-rich code examples
05Specialized patterns for HTTP endpoints and UI component props
06Structured workflow gates to ensure documentation completeness
ユースケース
01Documenting a new REST API or GraphQL endpoint
02Creating technical specifications for internal library functions
03Generating prop reference tables for UI component libraries