technical-writing은(는) 무엇을 하나요?
Claude Code 및 Codex를 위한 개발자 대상 기술 문서 작성 스킬입니다.
개요
이 스킬은 개발자(소프트웨어 엔지니어, API 사용자, SDK 통합자)를 위한 기술 문서를 작성할 때 사용합니다. 일관된 어조, 명확한 구조, 실행 가능한 예제 코드를 제공하여 문서의 가독성과 실용성을 높입니다.
주요 원칙
- 가독성: 짧은 문장과 명확한 표현을 사용합니다. 한 문장에 여러 정보를 담지 않습니다.
- 정확성: 모든 코드 예제는 실제로 컴파일/실행 가능해야 합니다. API 반환 값, 매개변수 이름, 엔드포인트 경로를 정확히 기재합니다.
- 간결함: 불필요한 수식어를 피하고 핵심 내용을 먼저 전달합니다. "간단히 말하면", "사실은" 등의 표현을 지양합니다.
- 일관성: 용어 사용에 일관성을 유지합니다. 예를 들어 "API"와 "api"를 혼용하지 않습니다.
지원 플랫폼
- Claude Code
- Codex
사용 방법
이 스킬은 시스템 프롬프트에 포함되어 다음과 같이 동작합니다:
- 전달된 주제에 대해 개발자 문서를 생성합니다.
- 문서 유형(튜토리얼, API 참조, 개념 설명, 문제 해결 가이드 등)에 적합한 구조를 자동으로 선택합니다.
- 적절한 수준의 세부 정보와 예제 코드를 포함합니다.
- 코드 블록에는 언어 식별자를 명시합니다.
예시 출력 포맷
# 제목 (h1)
## 개요 (h2)
짧은 설명을 작성합니다.
## 설치 (h2)
```bash
npm install my-package
사용 예 (h2)
기본 사용법 (h3)
from my_package import Client
client = Client(api_key="your-api-key")
result = client.query("example")
print(result)
고급 설정 (h3)
참고: 환경 변수로
MY_PACKAGE_API_KEY를 설정할 수도 있습니다.
const { Client } = require('my-package');
const client = new Client({ apiKey: process.env.MY_PACKAGE_API_KEY });
문제 해결 (h2)
| 문제 | 원인 | 해결 방법 |
|---|---|---|
| 401 오류 | 잘못된 API 키 | 올바른 API 키를 설정했는지 확인하세요. |
| 429 오류 | 요청 한도 초과 | 재시도 간격을 늘리세요. |
## 참고 사항
- 기술 용어는 영어 원어를 그대로 사용하되, 처음 등장 시 괄호 안에 한국어 설명을 추가할 수 있습니다. (예: Application Programming Interface (API))
- 코드 주석은 한국어로 작성하되, 너무 장황하지 않게 핵심만 설명합니다.
- 경고나 중요 정보는 `> **참고**` 또는 `> **경고**` 블록으로 강조합니다.
- 링크는 `[표시 텍스트](URL)` 형식을 따릅니다.