Individual skill
api-doc-standards
API 문서 작성 표준 및 패턴 라이브러리. doc-writer 에이전트가 REST/GraphQL/gRPC API 문서를 작성할 때 참조하는 표준. 'API 문서 표준', 'API 레퍼런스 작성' 요청 시 사용. 단, OpenAPI Spec 자동 생성이나 API 테스트 실행은 범위 밖.
ko/81-technical-writer/.claude/skills/api-doc-standards/skill.md
Source commit 8e8d35c6a19166614d1af1df85512266d51121ae
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- No
- Repository scan complete
- No
- Skill scan complete
- Yes
- Observed behavior
- Not checked yet
- Last checked
- Nov 3, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 1,323
- Repository last updated
- Mar 22, 2026
- License
- Apache-2.0
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- engineering Derived category
- docs Derived category
- docs-api Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
skill.mdcore · 4,111 bytes
Read excerpt
# API Doc Standards — API 문서 작성 표준
doc-writer 에이전트의 API 문서 품질을 표준화하는 규격과 패턴.
## REST API 문서 필수 섹션
```
1. 개요 — API 목적, 대상 사용자, 기본 URL
2. 인증 — 인증 방식, 토큰 획득/갱신
3. 공통 규격 — 요청/응답 포맷, 페이지네이션, 에러 코드
4. 엔드포인트 레퍼런스 — 리소스별 CRUD
5. 에러 처리 — 에러 코드 테이블, 트러블슈팅
6. 변경 이력 — 버전별 변경사항
```