Skip to content
cccskills
FreePublished on GitHub

doc-generator

Create or update API documentation from source code. The skill produces OpenAPI/Swagger specifications, descriptions of API operations, parameter and response references, authentication guidance, and practical examples for developers integrating an API.

OriginalShow the original description

Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation.

See how to install

Good for

  • Creating API documentation from source code
  • Generating OpenAPI/Swagger specifications
  • Preparing API request and response examples
  • Writing authentication and error references

Files included (2)

  • SKILL.md1.7 KB
  • generate-docs.py1.6 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

API Documentation Generator Skill

Generates

  • OpenAPI/Swagger specifications
  • API endpoint documentation
  • SDK usage examples
  • Integration guides
  • Error code references
  • Authentication guides

Documentation Structure

For Each Endpoint

## GET /api/v1/users/:id

### Description
Brief explanation of what this endpoint does

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |

### Response

**200 Success**
```json
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2025-01-15T10:30:00Z"
}
```

**404 Not Found**
```json
{
  "error": "USER_NOT_FOUND",
  "message": "User does not exist"
}
```

### Examples

**cURL**
```bash
curl -X GET "https://api.example.com/api/v1/users/usr_123" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

**JavaScript**
```javascript
const user = await fetch('/api/v1/users/usr_123', {
  headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());
```

**Python**
```python
response = requests.get(
    'https://api.example.com/api/v1/users/usr_123',
    headers={'Authorization': 'Bearer token'}
)
user = response.json()
```

Last Updated: August 4, 2026 Claude Code Version: 2.1.220 Sources:

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

blog-draft

FreeSummary

Turn ideas and reference materials into a blog draft with source citations. Work through research, topic development, an approved outline, and revisions, while saving source summaries and numbered drafts to track how the article develops.

  • Turning an idea into a structured blog draft
  • Writing an article from research and reference materials
  • Revising an existing draft while keeping earlier versions
luongnv89/claude-howto41.9KUpdated Oct 16, 2026

blog-draft

FreeSummary

Turn ideas and reference materials into a blog draft through research, outline approval, and revision. The workflow includes source citations, adjustments for the intended audience and tone, and separate files for each draft version.

  • Turning research materials into a blog post
  • Planning an article for a specific audience
  • Drafting articles with source citations
luongnv89/claude-howto41.9KUpdated Oct 16, 2026

blog-draft

FreeSummary

Turn ideas and reference materials into a blog draft through research, outline approval, and revision. The workflow includes source citations, adjustments for the intended audience and tone, and separate files for each draft version.

  • Turning research materials into a blog post
  • Planning an article for a specific audience
  • Drafting articles with source citations
luongnv89/claude-howto41.9KUpdated Oct 16, 2026

blog-draft

FreeSummary

Turn ideas and reference materials into a blog draft through research, discussion, and an approved outline. Produce cited articles tailored to the intended audience, then revise them while keeping each draft version.

  • Turning an idea into a blog draft
  • Writing an article from research materials
  • Agreeing on an outline before drafting
luongnv89/claude-howto41.9KUpdated Oct 16, 2026

brand-voice

FreeSummary

Write marketing copy, customer messages, and public content in a consistent brand voice. Apply predefined guidance on tone, sentence length, preferred terms, and concrete examples to keep communication friendly, professional, clear, and concise.

  • Write marketing copy in a consistent tone
  • Align customer messages with brand guidance
  • Simplify technical explanations for readers
luongnv89/claude-howto41.9KUpdated Oct 16, 2026

brand-voice

FreeSummary

Create marketing copy, customer messages, and public content with a consistent brand voice. Apply clear vocabulary, concise sentences, concrete examples, and a friendly, professional tone so readers can understand the value being offered.

  • Aligning marketing copy with a consistent brand voice
  • Keeping customer messages friendly and professional
  • Simplifying technical explanations for general readers
luongnv89/claude-howto41.9KUpdated Oct 16, 2026

See all skills by luongnv89

Report a problem with this skill