Does this skill support GraphQL documentation?

While the core principles of clear descriptions are universal, this skill is specifically optimized for RESTful API patterns, HTTP status codes, and path/query parameter structures.

Can I use this for writing high-level conceptual guides?

No, this skill is designed for technical reference documentation. For conceptual guides, user manuals, or functional overviews, use the writing-functional-docs skill instead.

How does it handle API versioning?

The skill includes specific patterns for documenting versioned URLs, managing backward compatibility notes, and clearly marking fields or endpoints as deprecated.

Does this skill generate the actual API implementation code?

This skill focuses exclusively on the documentation layer. To generate the underlying code or logic, you should utilize dev-team agents within the repository's workflow.

What is included in the quality checklist?

The checklist covers ten critical points including parameter documentation, response field types, realistic examples, and ensuring all potential error codes are defined.

Writing API Documentation

Name: Writing API Documentation
Author: LerianStudio

byLerianStudio

•

학습 및 문서화

Standardizes the creation of comprehensive REST API reference documentation including schemas, error codes, and request/response examples.

The writing-api-docs skill provides a structured framework for generating high-quality API reference materials that focus on technical accuracy and predictability. It enforces consistent patterns for endpoint descriptions, path and query parameters, and data type definitions while ensuring that error conditions and pagination details are explicitly documented. This skill is essential for engineering teams looking to maintain professional-grade documentation that adheres to RESTful principles and provides developers with realistic, actionable integration examples.

주요 기능

01Automated quality checklists to ensure documentation completeness

02Consistent data type mapping including UUID, ISO 8601, and JSONB

03Standardized endpoint documentation structure for REST APIs

04Pre-defined patterns for field descriptions and constraints

0517 GitHub stars

06Comprehensive error code documentation and resolution tables

사용 사례

01Documenting complex error handling and pagination logic for external developers

02Generating documentation for new REST API endpoints during active development

03Standardizing existing API references to follow consistent naming and formatting conventions

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add lerianstudio/ring writing-api-docs

For use in Claude.ai and ChatGPT

Download Skill