Spikard
Goldziher/spikard
Scaffold Spikard projects and generate code from OpenAPI, AsyncAPI, OpenRPC, GraphQL, and Protobuf schemas using the Spikard CLI or its MCP server.
API 문서 작성 표준 및 패턴 라이브러리. An agent skill from revfactory/harness-100.
Install API Doc Standards
$ npx skills add revfactory/harness-100 --skill api-doc-standards -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install revfactory/harness-100 api-doc-standards --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/revfactory/harness-100.git skills-src && mkdir -p .claude/skills && cp -r skills-src/ko/81-technical-writer/.claude/skills/api-doc-standards .claude/skills/api-doc-standards && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "api-doc-standards" agent skill from https://github.com/revfactory/harness-100/tree/main/ko/81-technical-writer/.claude/skills/api-doc-standards into .claude/skills/api-doc-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-doc-standards", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/revfactory/harness-100/tree/main/ko/81-technical-writer/.claude/skills/api-doc-standardsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add revfactory/harness-100 --skill api-doc-standards -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install revfactory/harness-100 api-doc-standards --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/revfactory/harness-100.git skills-src && mkdir -p .agents/skills && cp -r skills-src/ko/81-technical-writer/.claude/skills/api-doc-standards .agents/skills/api-doc-standards && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "api-doc-standards" agent skill from https://github.com/revfactory/harness-100/tree/main/ko/81-technical-writer/.claude/skills/api-doc-standards into .agents/skills/api-doc-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-doc-standards", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add revfactory/harness-100 --skill api-doc-standards -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install revfactory/harness-100 api-doc-standards --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/revfactory/harness-100.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/ko/81-technical-writer/.claude/skills/api-doc-standards .cursor/skills/api-doc-standards && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "api-doc-standards" agent skill from https://github.com/revfactory/harness-100/tree/main/ko/81-technical-writer/.claude/skills/api-doc-standards into .cursor/skills/api-doc-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-doc-standards", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/revfactory/harness-100.git --path ko/81-technical-writer/.claude/skills/api-doc-standards--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add revfactory/harness-100 --skill api-doc-standards -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install revfactory/harness-100 api-doc-standards --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/revfactory/harness-100.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/ko/81-technical-writer/.claude/skills/api-doc-standards .gemini/skills/api-doc-standards && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "api-doc-standards" agent skill from https://github.com/revfactory/harness-100/tree/main/ko/81-technical-writer/.claude/skills/api-doc-standards into .gemini/skills/api-doc-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-doc-standards", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install revfactory/harness-100 api-doc-standardsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add revfactory/harness-100 --skill api-doc-standards -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/revfactory/harness-100.git skills-src && mkdir -p .github/skills && cp -r skills-src/ko/81-technical-writer/.claude/skills/api-doc-standards .github/skills/api-doc-standards && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "api-doc-standards" agent skill from https://github.com/revfactory/harness-100/tree/main/ko/81-technical-writer/.claude/skills/api-doc-standards into .github/skills/api-doc-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-doc-standards", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add revfactory/harness-100 --skill api-doc-standards -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install revfactory/harness-100 api-doc-standards --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/revfactory/harness-100.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/ko/81-technical-writer/.claude/skills/api-doc-standards .opencode/skills/api-doc-standards && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "api-doc-standards" agent skill from https://github.com/revfactory/harness-100/tree/main/ko/81-technical-writer/.claude/skills/api-doc-standards into .opencode/skills/api-doc-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-doc-standards", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
api-doc-standards- GitHub stars
- 1.3k
- Token cost
- ~714 tokens
- SKILL.md length
- 207 words
- Files
- 1
- Skills in repo
- 464
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
API 문서 작성 표준 및 패턴 라이브러리. An agent skill from revfactory/harness-100.
- Tasks that involve Technical documentation
- SKILL.md covers REST API 문서 필수 섹션, 엔드포인트 문서 템플릿, 에러 응답 표준 형식 and HTTP 상태 코드 매핑, plus 5 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Tasks that involve OpenAPI specifications
What it does
API Doc Standards is an agent skill from revfactory/harness-100. API 문서 작성 표준 및 패턴 라이브러리. doc-writer 에이전트가 REST/GraphQL/gRPC API 문서를 작성할 때 참조하는 표준. 'API 문서 표준', 'API 레퍼런스 작성' 요청 시 사용. 단, OpenAPI Spec 자동 생성이나 API 테스트 실행은 범위 밖.
Its SKILL.md is about 710 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Backend & APIs, covering Technical documentation, OpenAPI specifications and gRPC and Protobuf. It works with gRPC, OpenAPI and GraphQL. The licence is Apache-2.0.
When your agent uses it
- Tasks that involve Technical documentation
- Tasks that involve OpenAPI specifications
- Tasks that involve gRPC and Protobuf
Example prompts
- “API 문서 표준”
- “API 레퍼런스 작성”
- “/api-doc-standards”
What it can do on your machine
Read from SKILL.md and the folder at commit 8e8d35c. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown and json).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
API Doc Standards loads about 714 tokens when it runs. Until then it costs about 45 tokens; SKILL.md has 207 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from revfactory/harness-100 at commit 8e8d35c, republished under its Apache-2.0 licence (© revfactory). 207 words, ~714 tokens.
Download SKILL.mdSave it as
.claude/skills/api-doc-standards/SKILL.md (or your agent's skills folder).- name
- api-doc-standards
- description
- API 문서 작성 표준 및 패턴 라이브러리. doc-writer 에이전트가 REST/GraphQL/gRPC API 문서를 작성할 때 참조하는 표준. 'API 문서 표준', 'API 레퍼런스 작성' 요청 시 사용. 단, OpenAPI Spec 자동 생성이나 API 테스트 실행은 범위 밖.
API Doc Standards — API 문서 작성 표준
doc-writer 에이전트의 API 문서 품질을 표준화하는 규격과 패턴.
REST API 문서 필수 섹션
1. 개요 — API 목적, 대상 사용자, 기본 URL
2. 인증 — 인증 방식, 토큰 획득/갱신
3. 공통 규격 — 요청/응답 포맷, 페이지네이션, 에러 코드
4. 엔드포인트 레퍼런스 — 리소스별 CRUD
5. 에러 처리 — 에러 코드 테이블, 트러블슈팅
6. 변경 이력 — 버전별 변경사항엔드포인트 문서 템플릿
## POST /api/v1/users
사용자를 생성합니다.
### 요청
**헤더**
| 헤더 | 값 | 필수 |
|------|-----|------|
| Authorization | Bearer {token} | O |
| Content-Type | application/json | O |
**본문**
| 필드 | 타입 | 필수 | 설명 | 제약조건 |
|------|------|------|------|---------|
| email | string | O | 이메일 | RFC 5322, 254자 |
| name | string | O | 이름 | 2~50자 |
| role | string | X | 역할 | admin/user/viewer, 기본: user |
### 응답
**성공 (201 Created)**
{ "id": "usr_abc123", "email": "...", "name": "..." }
**에러**
| 상태 | 코드 | 설명 |
|------|------|------|
| 400 | INVALID_EMAIL | 이메일 형식 오류 |
| 409 | DUPLICATE_EMAIL | 중복 이메일 |
| 422 | VALIDATION_ERROR | 유효성 오류 |에러 응답 표준 형식
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "요청한 리소스를 찾을 수 없습니다.",
"details": [{ "field": "user_id", "reason": "존재하지 않음" }],
"request_id": "req_xyz789"
}
}HTTP 상태 코드 매핑
| 범위 | 의미 | 사용 코드 |
|---|---|---|
| 2xx | 성공 | 200, 201, 204 |
| 4xx | 클라이언트 에러 | 400, 401, 403, 404, 409, 422, 429 |
| 5xx | 서버 에러 | 500, 502, 503 |
페이지네이션 문서 표준
커서 기반 (권장)
| 파라미터 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| limit | integer | 20 | 항목 수 (1~100) |
| cursor | string | - | 다음 페이지 커서 |
응답 메타: has_more, next_cursor
오프셋 기반
| 파라미터 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| page | integer | 1 | 페이지 번호 |
| per_page | integer | 20 | 항목 수 |
| sort | string | created_at | 정렬 기준 |
| order | string | desc | 정렬 방향 |
인증 섹션 표준
## 인증
모든 API 요청에 Bearer 토큰 필요.
### 토큰 획득: POST /auth/token
### 토큰 사용: Authorization: Bearer {access_token}
### 토큰 갱신: POST /auth/refresh (만료 시)
| 상태 코드 | 원인 | 조치 |
|----------|------|------|
| 401 | 토큰 누락/만료 | 재발급 |
| 403 | 권한 부족 | 역할 확인 |Rate Limiting 문서 표준
| 플랜 | 제한 | 단위 |
|---|---|---|
| Free | 100 | 분당 |
| Pro | 1,000 | 분당 |
| Enterprise | 10,000 | 분당 |
응답 헤더: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
초과 시: 429 + Retry-After 헤더
버저닝 문서 표준
- URL 경로 버전:
/api/v1/,/api/v2/ - 하위 호환: 새 필드/엔드포인트/옵션 파라미터 추가
- 호환 불가: 필드 삭제, 구조 변경, 필수 파라미터 추가 → 새 버전 필요
- 폐기 예고: 최소 6개월 전
문서 품질 체크리스트
| 항목 | 기준 |
|---|---|
| 예시 | 모든 엔드포인트에 요청+응답+에러 |
| 타입 | string, integer, boolean, array, object |
| 필수/선택 | 모든 파라미터에 표시 |
| 제약조건 | 길이, 허용 값, 패턴 |
| 인증 | 엔드포인트별 필요 권한 |
| SDK 예제 | cURL + 1개 이상 언어 |
| 변경 이력 | 날짜 + 변경 + 영향 범위 |
© revfactory, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in ko/81-technical-writer/.claude/skills/api-doc-standards of revfactory/harness-100.
Open the folder on GitHubat commit 8e8d35c
Compare with similar skills
API Doc Standards next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| API Doc Standards this skillrevfactory/harness-100 | 1.3k | — | ~714 | Automated safety check: Pass | Apache-2.0 | |
| SpikardGoldziher/spikard | 123 | — | ~799 | Automated safety check: Pass | MIT | |
| Uxcholon-run/uxc | 115 | — | ~1.8k | Automated safety check: Pass | MIT | |
| API Contract Detectionprime-radiant-inc/greenfield | 292 | — | ~4.2k | Automated safety check: Pass | Apache-2.0 | |
| API Architectcuriositech/some_claude_skills | 243 | 1 repos | ~1.4k | Automated safety check: Pass | MIT | |
| API Designmajiayu000/spellbook | 286 | — | ~2.1k | Automated safety check: Pass | MIT |
Similar skills
Uxc
holon-run/uxc
Discover and call remote schema-exposed interfaces with UXC.
API Contract Detection
prime-radiant-inc/greenfield
Finds OpenAPI, GraphQL, Protobuf and JSON Schema files in a codebase and extracts behavioral claims from them as part of a reverse-engineering workflow.
API Architect
curiositech/some_claude_skills
Expert API designer for REST, GraphQL, gRPC architectures. An agent skill from curiositech/some_claude_skills.
API Design
majiayu000/spellbook
REST/GraphQL/gRPC API design best practices. An agent skill from majiayu000/spellbook.
API Forge
EliasOulkadi/shokunin
Design REST/GraphQL APIs with OpenAPI 3.1, error handling, pagination, rate limiting, webhooks, and idempotency.
More from revfactory/harness-100
All 464 skills in this repoAnti Bot Analyzer
revfactory/harness-100
A skill for analyzing website anti-bot defense mechanisms and developing legitimate evasion strategies.
API Error Design Patterns
revfactory/harness-100
Reference for designing how an API reports failures: structured error codes, response shapes, client-friendly messages, an error catalog and retry or fallback advice.
API Security Checklist
revfactory/harness-100
Walks a backend-dev agent through OWASP API Top 10 checks, authentication and authorization patterns, and defense code during API design.
Arg Parser Generator
revfactory/harness-100
Methodology for systematically designing and generating CLI tool argument parser structures.
Audience Segmentation
revfactory/harness-100
Audience segmentation skill used by the analyst and curator agents.
Audio Storytelling
revfactory/harness-100
Audio storytelling skill used by the podcast scriptwriter and show note editor.
Related
Categories
Questions about API Doc Standards
What does API Doc Standards do?
API 문서 작성 표준 및 패턴 라이브러리. An agent skill from revfactory/harness-100. API Doc Standards is an agent skill from revfactory/harness-100. API 문서 작성 표준 및 패턴 라이브러리.
When should I use API Doc Standards?
API Doc Standards fits situations like: tasks that involve Technical documentation; tasks that involve OpenAPI specifications; tasks that involve gRPC and Protobuf.
How do I install API Doc Standards in Claude Code?
Run `npx skills add revfactory/harness-100 --skill api-doc-standards -a claude-code`. Or copy the skill folder (ko/81-technical-writer/.claude/skills/api-doc-standards in revfactory/harness-100) into .claude/skills/api-doc-standards in your project. Claude Code loads it when a task matches its description.
How do I install API Doc Standards in Codex?
Run `npx skills add revfactory/harness-100 --skill api-doc-standards -a codex`. Or copy the skill folder (ko/81-technical-writer/.claude/skills/api-doc-standards in revfactory/harness-100) into .agents/skills/api-doc-standards in your project. Codex loads it when a task matches its description.
Can I use API Doc Standards in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add revfactory/harness-100 --skill api-doc-standards -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-doc-standards, .gemini/skills/api-doc-standards, .github/skills/api-doc-standards and .opencode/skills/api-doc-standards in your project.
What does API Doc Standards need to run?
SKILL.md names no scripts, command-line tools or credentials: API Doc Standards is instructions for the agent only.
Does API Doc Standards access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is API Doc Standards safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does API Doc Standards use?
API Doc Standards is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does API Doc Standards use?
About 714 tokens (SKILL.md is roughly 2.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to API Doc Standards?
Skills that share tags, products or a category with API Doc Standards: Spikard (Goldziher/spikard, 123 stars), Uxc (holon-run/uxc, 115 stars), API Contract Detection (prime-radiant-inc/greenfield, 292 stars) and API Architect (curiositech/some_claude_skills, 243 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains API Doc Standards?
revfactory (a GitHub user) maintains it in revfactory/harness-100, which has 1,290 GitHub stars. The repository holds 464 skills in this directory. The repository was last updated on March 22, 2026.
Source: revfactory/harness-100 on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.