ReddRadar
Agent skill
api-documentation
Write accurate and complete library API documentation. Use when creating API docs, README files, or function reference documentation. Ensures all signatures, parameters, return types, and examples are precise.
Install this agent skill to your Project
npx add-skill https://github.com/revfactory/claude-code-harness/tree/main/experiments/results/case-004/harness/.claude/skills/api-documentation
SKILL.md
API Documentation
문서 작성 워크플로우
- 소스 코드에서 모든 public 함수 시그니처 추출
- 각 함수의 파라미터 (필수/선택) 및 반환값 타입 확인
- 함수 문서 템플릿에 맞춰 작성
- format 토큰 등 열거형 값은 전수 나열
- 예제 코드는 실제 동작과 일치하도록 작성
- 정확성 체크리스트로 최종 검증
함수 문서 템플릿
### `functionName(param1, param2[, optionalParam])`
설명 한 문장.
**Parameters**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| param1 | `Type` | Yes | 설명 |
| optionalParam | `Type` | No | 설명. 기본값: `default` |
**Returns**
`ReturnType` - 설명
**Example**
\`\`\`javascript
const result = functionName('input');
// => 'expected output'
\`\`\`
정확성 체크리스트
- 모든 함수의 선택적 파라미터가 명시되었는가
- 반환값 타입이 정확한가 (음수 가능성 포함)
- 예제 출력이 영어 기준인가 (i18n 아닌 경우)
- format 토큰이 전수 나열되었는가
- 실제 사용 가능한 코드인가
상세 format 토큰 목록은 references/format-tokens.md 참조.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
revfactory/claude-code-harness
interpreter-design
Programming language interpreter design and implementation guide. Use when the user requests building an interpreter, parser, lexer, or language implementation — including Pratt parsing, AST evaluation, scope chains, and closures.
revfactory/claude-code-harness
express-api-design
Express.js REST API design and implementation guide. Use when implementing REST API endpoints, creating Express routes, or setting up API project structure with MVC pattern.
revfactory/claude-code-harness
query-engine-design
SQL query engine design and implementation guide. Use when the user requests building a SQL engine, query parser, query planner, or query executor — including in-memory storage, SQL parsing, and query optimization.
revfactory/claude-code-harness
async-debugging
Analyze and fix race conditions and concurrency bugs in async code. Use when debugging async bugs, fixing race conditions, resolving concurrency issues, or when shared state is accessed by multiple async operations.
revfactory/claude-code-harness
reactive-spreadsheet-design
리액티브 스프레드시트 엔진 설계 가이드. 셀 수식 파싱, 의존성 그래프(DAG), 증분 재계산, 내장 함수 구현 시 사용한다.
revfactory/claude-code-harness
lsp-design
Language Server Protocol 서버 구현 가이드. LSP 서버, 증분 파싱, 자동완성, 진단, Go-to-Definition, 호버를 구현할 때 사용한다.
Didn't find tool you were looking for?