Menu
기술 문서를 정확하고 명확하고 실행 가능하게 작성·윤문하는 스킬. 개발 가이드·API 문서·README·테크 블로그·기술 리포트를 대상으로, 번역투·hype·모호성을 제거하고 전제조건·코드 예제·용어 일관성·구조를 보강한다.
Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.
Basé sur la classification professionnelle SOC
| name | tech-writer |
| description | 기술 문서를 정확하고 명확하고 실행 가능하게 작성·윤문하는 스킬. 개발 가이드·API 문서·README·테크 블로그·기술 리포트를 대상으로, 번역투·hype·모호성을 제거하고 전제조건·코드 예제·용어 일관성·구조를 보강한다. |
| origin | harness |
| workloads | ["report"] |
기술 문서를 정확하고 명확하고 실행 가능하게 작성·개선하는 스킬. 개발 가이드, API 문서, README, 테크 블로그, 기술 리포트, 설계서, 업무 문서를 지원한다.
| 장르 | 성격 | 핵심 품질 축 |
|---|---|---|
| 개발 가이드·튜토리얼 | 절차 중심 | 전제조건·번호 목록·복사가능 명령·기대 출력 |
| API 문서·레퍼런스 | 정밀 명세 | 파라미터 표·예제·에러 코드·일관 표기 |
| README | 진입점 | 빠른 시작·설치·배지·구조 |
| 테크 블로그 | 설득·설명 | 흐름·코드 예제·근거·과장 절제 |
| 기술 리포트·설계서 | 의사결정 | 구조·근거·트레이드오프·중립 톤 |
| 업무 문서·메일·공지 | 전달·요청 | 간결·실행항목·명확한 의도 |
입력이 개요, 불릿 메모, 요점일 때. 구조와 흐름을 정하고 새 문서를 작성한다.
<!-- TODO: 확인 필요 -->로 표시입력이 완성된 초안일 때. 다음을 정리한다:
초안이 있으나 절과 예제가 비어 있을 때. 빠진 부분을 작성하고 전체 흐름을 다시 본다.
## 시작하기
### 전제조건
- Node.js 18+
- npm 또는 yarn
- Git
### 1단계: 저장소 복제
$ git clone https://github.com/example/repo.git
$ cd repo
### 2단계: 의존성 설치
$ npm install
### 3단계: 환경 변수 설정
.env.example 을 .env 로 복사:
$ cp .env.example .env
### 4단계: 서버 시작
$ npm run dev
기대 출력:
Server running on http://localhost:3000
### 다음 단계
[Link to first feature guide]
## POST /users
사용자를 생성합니다.
### 요청
| 필드 | 타입 | 필수 | 설명 |
|------|------|------|------|
| name | string | O | 사용자 이름, 1–100자 |
| email | string | O | 이메일 주소, 유효한 형식 |
| role | string | X | "admin" 또는 "user", 기본값 "user" |
### 응답 (201 Created)
```json
{
"id": "user_123",
"name": "Alice",
"email": "alice@example.com",
"role": "user",
"createdAt": "2026-06-01T10:30:00Z"
}
| 상태 | 설명 |
|---|---|
| 400 | 요청 형식 오류 또는 이메일 중복 |
| 500 | 서버 오류 |
curl -X POST http://localhost:3000/users \
-H "Content-Type: application/json" \
-d '{
"name": "Alice",
"email": "alice@example.com"
}'
## 일반 지침
- **한국어로 작성** (코드와 공식 용어는 영어 유지)
- **기술 용어는 영어와 한글 병행** (처음 사용 시): 컨테이너(container), API(application programming interface)
- **문장은 간결하고 능동태** — "~를 하면 된다" 형태 선호
- **코드 블록은 언어 태그 필수** — ` ```javascript`, ` ```bash`, ` ```sql` 등
- **주의/경고는 명확히** — "주의:", "⚠️ 위험:", "💡 팁:" 등 마크다운 포맷 사용
- **표와 목록으로 정보 정리** — 산문이 너무 길어지지 않기
- **"다음 단계" 또는 "관련 문서" 섹션 포함** — 독자가 다음 할 일을 알 수 있도록
## 최악의 기술 문서
- "이 기능을 쉽게 사용할 수 있습니다" (어떻게? 정확히 뭘 하나?)
- 전제조건 없이 명령 나열 (Node.js 설치 안 된 사용자는?)
- 코드 예제 없이 "다음과 같이 코딩합니다" (정확한 문법은?)
- 화면 스크린샷만 있고 텍스트 설명 없음 (접근성, 검색 불가)
- API 응답 구조를 설명만 하고 실제 JSON 보여 주지 않음
## 관련 스킬
- markdown-writing — 장문의 구조화된 마크다운 작성
- documentation-lookup — 공식 문서 검색
- security-review — 기술 문서의 보안 정확성 검증
Create professional architecture, workflow, sequence, data-flow, and lifecycle/state diagrams as standalone HTML files with SVG graphics, a built-in dark/light theme toggle, and one-click export to PNG / JPEG / WebP / SVG. Accepts plain-language descriptions or pasted Mermaid code (flowchart, sequenceDiagram, stateDiagram) and lays the diagram out from scratch in archify style. Use when the user asks for system architecture diagrams, infrastructure diagrams, cloud architecture visualizations, security diagrams, network topology, technical workflows, approval flows, runbooks, CI/CD flows, process diagrams, API call sequences, request lifecycles, data pipelines, ETL/ELT maps, PII boundaries, data lineage, state machines, lifecycle diagrams, status transitions, or asks to convert/beautify a Mermaid diagram.
Data analysis methodology — how to frame a question, pick the right technique, avoid statistical traps, and connect results to decisions. NOT a tool tutorial (pandas/polars/duckdb live in python-data-analysis) — this is the judgment layer: problem framing, analysis-type decision tree, experiment/causal design, and domain playbooks (churn, cohort, funnel, anomaly). Trigger: "왜 늘었/줄었지", 이탈 분석, 코호트, 퍼널, A/B 테스트, 인과추론, 상관 vs 인과, 유의성, 세그먼트, 이상 탐지, "이 데이터로 뭘 봐야", 지표 설계, exploratory analysis.
AWS cost management and FinOps practice — Cost Explorer, Budgets, Cost Anomaly Detection, CUR/data exports, cost allocation tags, Cost Categories, Savings Plans vs Reserved Instances, Compute Optimizer / Cost Optimization Hub, rightsizing, unit economics, showback/chargeback. Grounded in the FinOps Foundation Framework (Inform / Optimize / Operate). Trigger: cost anomaly, Savings Plan, Reserved Instance, rightsizing, cost allocation tag, chargeback, showback, unit cost, budget alert, CUR, Cost Explorer, unblended/amortized cost, RI coverage, commitment, "왜 청구서가 늘었지".
Track and report AI model token usage, spending, and budgets from a local cost-tracking database.
Multi-source deep research using firecrawl and exa MCPs. Searches the web, synthesizes findings, and delivers cited reports with source attribution. Use when the user wants thorough research on any topic with evidence and citations.
Conduct market research, competitive analysis, investor due diligence, and industry intelligence with source attribution and decision-oriented summaries. Use when the user wants market sizing, competitor comparisons, fund research, technology scans, or research that informs business decisions.