skills.rest
infiquetra
infiquetraOFFICIAL
Explore all skills by this author →
GitHub

sdk-documentation

Generate SDK documentation with API references from code comments.

8|Updated Nov 26, 2025
Search Tags:#developer tools#documentation#code generation#sdk#usage guide#api reference
One-click install
npx skills add https://github.com/infiquetra/infiquetra-claude-plugins --skill sdk-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sdk-documentation
Source: https://github.com/infiquetra/infiquetra-claude-plugins/tree/main/plugins/sdk-lifecycle/skills/sdk-documentation
Command: npx skills add https://github.com/infiquetra/infiquetra-claude-plugins --skill sdk-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive documentation for Software Development Kits (SDKs), streamlining the process of generating API references, usage guides, and portal integration.

Core Features & Use Cases

  • API Reference Generation: Extracts documentation directly from code comments and docstrings.
  • Usage Guide Templates: Provides structured templates for quickstarts, examples, and troubleshooting.
  • Documentation Portal Integration: Facilitates automated publishing workflows.
  • Use Case: A developer needs to document a newly created Python SDK. They can use this skill to automatically generate an API reference from their docstrings, create a README with installation and quick start examples, and prepare the content for publishing to a documentation portal.

Quick Start

Use the sdk-documentation skill to generate documentation for your Python SDK located in the current directory.

Frequently Asked Questions about sdk-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate SDK documentation from code comments automatically?▼

You can generate SDK documentation by extracting API references directly from code comments and docstrings. This Skill automates the extraction process to build comprehensive API references for Python, .NET, and TypeScript projects.

What's the best way to create usage guides for a Python SDK?▼

The best way to create usage guides for a Python SDK is to use structured templates for quickstarts, examples, and troubleshooting. This Skill provides these templates to streamline the generation of comprehensive Python SDK usage guides.

Does SDK documentation generation work with TypeScript and DocFX for .NET?▼

SDK documentation generation supports TypeScript projects using TypeDoc and .NET projects using DocFX. It also supports Python projects using Sphinx, accommodating multiple development environments.

Do I need Sphinx installed to automate Python API reference generation?▼

Yes, you need Sphinx installed to automate Python API reference generation. This Skill requires Sphinx for Python projects, DocFX for .NET, and TypeDoc for TypeScript to extract documentation from code comments.

Can I automate publishing workflows to a documentation portal from TypeDoc?▼

Yes, you can automate publishing workflows to a documentation portal. This Skill facilitates documentation portal integration, allowing you to automatically prepare and publish generated API references and usage guides.

What is automated SDK documentation extraction and when do I need it?▼

Automated SDK documentation extraction is the process of parsing code comments to generate API references and usage guides. You need it when you want to streamline the creation of comprehensive documentation for Python, .NET, or TypeScript SDKs.

Related Skills

Explore More Software Engineering Skills→
penghang1223penghang1223
1

doc-generator

Extract code comments and annotations into Markdown, JSON, or OpenAPI YAML documentation.

Community
Intermediate
tranceetrancee

maven-central-publisher

Automates publishing Java, Kotlin, or JVM libraries to Maven Central via Portal API or central-publishing-maven-plugin.

Community
Advanced
JhabbigJhabbig

python-code-style

Standardize Python code style with ruff, mypy, and Google-style docstrings.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced