Does it support specific documentation frameworks?

Yes, it includes specific best practices and setup guidance for popular documentation tools like VitePress and GitBook.

Can it help with TypeScript-specific documentation?

Absolutely; it focuses on code-forward presentation and uses TypeScript syntax to clearly define parameters, return types, and optionality.

What libraries inspired these documentation patterns?

The patterns are derived from analysis of best-in-class SDK documentation, including wagmi, viem, and TanStack libraries.

How does this skill improve documentation quality?

It enforces a strict Documentation Type Router, preventing the common mistake of mixing learning-oriented tutorial steps with information-oriented technical reference details.

SDK Documentation Specialist

Name: SDK Documentation Specialist
Author: enitrat

byenitrat

•

학습 및 문서화

Generates comprehensive, high-quality SDK documentation following industry best practices for public libraries and APIs.

This skill equips Claude with the expertise needed to architect and write professional-grade SDK documentation. It enforces a strict separation between tutorials, how-to guides, API references, and conceptual explanations, ensuring clarity and utility for developer audiences. By following patterns used in top-tier libraries like wagmi and TanStack, it helps create scannable, code-forward content that includes full runnable examples, rigid parameter structures, and platform-specific configurations for tools like VitePress and GitBook.

주요 기능

01Provides domain-agnostic patterns adaptable for web3, backend, or frontend SDKs

0212 GitHub stars

03Enforces 'code-forward' philosophy with complete, runnable file examples

04Implements a Documentation Type Router to separate tutorials from technical references

05Standardizes API reference layouts with dedicated sections for imports, usage, and parameters

06Includes configuration guidance for VitePress and GitBook documentation sites

사용 사례

01Building a developer portal for a new public library from scratch

02Refactoring messy API references into scannable, type-safe documentation pages

03Drafting 'Getting Started' tutorials that guide users through a library's core features

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add enitrat/skill-issue sdk-documentation

For use in Claude.ai and ChatGPT

주요 기능

01Provides domain-agnostic patterns adaptable for web3, backend, or frontend SDKs

0212 GitHub stars

03Enforces 'code-forward' philosophy with complete, runnable file examples

04Implements a Documentation Type Router to separate tutorials from technical references

05Standardizes API reference layouts with dedicated sections for imports, usage, and parameters

06Includes configuration guidance for VitePress and GitBook documentation sites

사용 사례

01Building a developer portal for a new public library from scratch

02Refactoring messy API references into scannable, type-safe documentation pages

03Drafting 'Getting Started' tutorials that guide users through a library's core features

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add enitrat/skill-issue sdk-documentation

For use in Claude.ai and ChatGPT