What documentation types does this skill support?

It is specifically designed for API references, developer tutorials, SDK guides, and integration walkthroughs.

Can I use this for existing documentation?

Yes, it is ideal for auditing and updating current docs to ensure they meet modern accessibility, formatting, and terminology standards.

Does it help with code samples?

Absolutely. It provides checklists to ensure code samples include authentication handling, error management, and runnable curl equivalents.

How does it handle documentation accessibility?

The skill enforces proper heading hierarchies, alt-text for images, and specific annotations for code snippets to ensure content is accessible to all users.

API Documentation Style Guide

Name: API Documentation Style Guide
Author: gtmagents

bygtmagents

•

学习与文档

Standardizes API and SDK documentation through consistent formatting, professional tone, and production-ready code sample templates.

关于

The API Style Guide skill provides a comprehensive framework for creating and auditing high-quality technical documentation within Claude Code. It ensures consistency across API references, tutorials, and SDK guides by enforcing specific rules for language, structure, and code blocks. Whether you are drafting new endpoints or reviewing community contributions, this skill helps DevRel and engineering teams maintain professional, accessible, and localization-ready documentation that improves the overall developer experience.

主要功能

Ensures documentation accessibility through heading hierarchy and snippet annotations
Standardizes metadata usage including versioning, beta flags, and locale indicators
Validates code samples for authentication handling, pagination patterns, and inline comments
Provides standardized templates for API references, tutorials, and troubleshooting guides
29 GitHub stars
Enforces consistent language, tone, and terminology across all technical documents

使用场景

Creating developer tutorials with standardized prerequisites, step-by-step logic, and next steps
Auditing existing documentation for style compliance and formatting consistency before a release
Generating structured API reference entries with consistent parameter and response descriptions

关于

主要功能

Ensures documentation accessibility through heading hierarchy and snippet annotations
Standardizes metadata usage including versioning, beta flags, and locale indicators
Validates code samples for authentication handling, pagination patterns, and inline comments
Provides standardized templates for API references, tutorials, and troubleshooting guides
29 GitHub stars
Enforces consistent language, tone, and terminology across all technical documents

使用场景

Creating developer tutorials with standardized prerequisites, step-by-step logic, and next steps
Auditing existing documentation for style compliance and formatting consistency before a release
Generating structured API reference entries with consistent parameter and response descriptions