본문으로 건너뛰기
cccskills
무료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.

한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.

원문원문 설명 보기

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.

설치 방법 보기

이럴 때 유용합니다

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

포함된 파일(2)

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

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

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:

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

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-howto4.2만2026년 10월 16일 업데이트

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-howto4.2만2026년 10월 16일 업데이트

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-howto4.2만2026년 10월 16일 업데이트

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-howto4.2만2026년 10월 16일 업데이트

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-howto4.2만2026년 10월 16일 업데이트

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-howto4.2만2026년 10월 16일 업데이트

luongnv89의 스킬 모두 보기

이 스킬의 문제 신고