Tech Writer — Redação e Revisão de Documentação Técnica
TeiNam/tech-writer-skills
Reescreve e revisa docs técnicas eliminando hype, estruturando procedimentos.
Ver no GitHubSkill Claude que reescreve e revisa documentação técnica de TI com precisão, clareza e executabilidade. Remove jargão, hype e ambiguidades; reforça estrutura (listas numeradas, tabelas, advertências); valida código e dados. Suporta coreano e inglês.
Instalação
npx convez-ai TeiNam/tech-writer-skills1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.
Métricas
Casos de uso
- Converter notas e pontos-chave em documentação de API ou guias estruturados
- Revisar drafts de documentação técnica para clareza, consistência de termos e executabilidade
- Detectar e redactar credenciais (API keys, tokens, senhas) em código e exemplos
- Validar precisão de blocos de código, versões de API e assinaturas técnicas
Veredito

Ferramenta madura e bem-arquitetada para documentação técnica em escala. Modo fast (monolítico) para textos curtos e modo strict (pipeline 5 agentes) para validação rigorosa de documentos críticos. Força real em detecção de credenciais, remoção de anti-padrões AI/marketing e garantia de fidelidade técnica. Ideal para equipes que precisam manter qualidade e segurança em documentação multilíngue.
README
A tradução para o português deste README ainda está na fila.
Tech Writer — IT 기술 문서 작성·윤문 하네스
IT 기술 문서를 정확하고 명확하고 실행 가능하게 작성·윤문해주는 Claude 스킬. 노트·요점에서 문서를 새로 작성하거나(write), 기존 초안을 다듬는다(polish). 한국어·영어 양방향.
무엇을 하나
- 번역투·hype·모호성 제거 — "강력한", "쉽게", "~를 통해", dive into, "단순한 X가 아니라 Y다"(안티테제), em-dash 과용 같은 2025–26 AI·과장·평가절하 표현을 구체 사실로 환원
- 구조 보강 — 절차는 번호 목록으로, 비교는 표로, 긴 산문은 헤딩으로 (구조를 제거 대상이 아니라 권장 자산으로 본다)
- 실행가능성 확보 — 코드블록 언어 태그, 위험 명령 경고, 전제조건 블록, 복사-실행 가능한 명령
- 비밀정보 탐지·치환 — 코드·예제에 박힌 실제 API 키·토큰·비밀번호를 플레이스홀더로 redact (C-7) + 회전 권고
- 용어·식별자 일관성 — 표기·약어 통일, 본문↔코드 식별자 일치 검증
- 정확성 보존 — 코드·수치·버전·API 시그니처는 100% 보존, 작성 모드에서도 날조 금지
대상 장르
개발 가이드·튜토리얼 · API 레퍼런스 · README · 테크 블로그 · 기술 리포트·RFC/설계서 · 업무 문서(메일·공지·회고)
사용 방법
새 세션에서 트리거 문구와 함께 텍스트를 첨부한다.
# 윤문 (기존 글 다듬기)
이 기술 문서 명확하게 다듬어줘:
<문서 본문>
# 작성 (노트 → 문서)
이 노트로 API 문서 작성해줘:
<요점·불릿 메모>
오케스트레이터가 자동으로 모드(write/polish)·언어(KR/EN)·장르를 판별하고 파이프라인을 실행한 뒤 final.md를 반환한다.
옵션 (자연어로)
| 옵션 | 값 |
|---|---|
장르: | 가이드 | API | README | 블로그 | 리포트 | 업무 |
작업: | 작성 | 윤문 | 하이브리드 |
언어: | 한국어 | 영어 |
독자: | 입문 | 중급 | 고급 |
--strict | 5인 파이프라인 정밀 검증 |
두 가지 모드
- Fast (디폴트) —
tech-writer-monolith단일 호출. 5,000자 이하 2~3분. 탐지·작성/윤문·자체검증을 한 콜에서. - Strict (
--strict) — 5인 파이프라인. 탐지 → 작성/윤문 → 병렬 검증(정확성 + 명확성) → 종합 판정. 정밀 검증·장문·중요 문서용.
파이프라인 (Strict)
입력 → [doc-quality-detector] → [tech-doc-writer]
→ [tech-fidelity-auditor ∥ doc-clarity-reviewer]
→ 종합 판정 → final.md
| 에이전트 | 역할 |
|---|---|
| doc-quality-detector | 제거 결함(번역투·hype) + 보강 결함(전제·코드·구조) 탐지 |
| tech-doc-writer | 노트→문서 작성 또는 finding 기반 윤문 |
| tech-fidelity-auditor | 코드·수치·식별자·API 시그니처 14항 정확성 감사 |
| doc-clarity-reviewer | 잔존 결함·실행가능성·과윤문 판정, 등급 산정 |
품질 등급
등급 정의의 단일 진실 원천(SSOT) 은 core/references/quick-rules.md의 "등급 기준 (정본 SSOT)"이다. 아래는 요약이며, 충돌 시 룰북이 우선한다.
| 등급 | 기준 (윤문 모드 / write 모드는 변경률 제외 6항) |
|---|---|
| A | S1 0건, S2 2건 이하, 자체검증 7항 통과 (write 6항) |
| B | S1 0건, S2 4건 이하, 자체검증 6항 이상 (write 5항+) |
| C | S1 1~2건 또는 자체검증 미달 — strict/2차 작업 권고 |
| D | S1 3건 이상 또는 변경률 60% 초과(윤문) — 사람 검토 |
멀티 프로바이더 구조
이 스킬은 하나의 SSOT(core/)에서 프로바이더별 산출물을 빌드한다. 콘텐츠는 한 곳에서만 관리하고, 도구명·경로·매니페스트 포맷 차이는 어댑터가 흡수한다.
core/ # 단일 진실 원천 (여기만 편집)
├── registry.json # 스킬·오케스트레이터·에이전트 5종 메타
├── orchestrator.md # 파이프라인 로직 (토큰화)
├── agents/*.md # 에이전트 5종 프롬프트 본문 (토큰화)
└── references/*.md # 룰북 3종 (프로바이더 무관, verbatim)
providers/
├── claude/ # provider.json(토큰맵) + snippets/
└── kiro/ # provider.json(토큰맵) + snippets/
scripts/build.mjs # core + provider → dist
dist/ # 빌드 산출물
├── claude/ skill/SKILL.md · skill/references/ · agents/*.md
└── kiro/ skills/tech-writer/ · agents/*.json (오케스트레이터 + 워커 5종)
install.sh # dist를 ~/.claude 또는 ~/.kiro 에 설치
새 프로바이더는 providers/<id>/에 provider.json(토큰맵) + 스니펫을 추가하고 scripts/build.mjs에 빌더를 등록하면 된다. core/는 손대지 않는다.
빌드 & 설치
core/를 수정했으면 빌드부터 한다(Node 18+ 필요, 외부 의존성 없음).
node scripts/build.mjs # 모든 프로바이더 빌드 → dist/
node scripts/build.mjs kiro # 특정 프로바이더만
node scripts/build.mjs --check # dist 가 최신인지만 검증(드리프트 시 비0 종료, CI용)
dist/는 커밋 대상이다(설치 시 Node 불필요).core/·providers/를 고치면 재빌드 후 함께 커밋한다..github/workflows/build-check.yml이 PR·push마다--check로 drift를 막는다.
설치는 install.sh로:
./install.sh claude # ~/.claude/{skills/tech-writer, agents} 에 설치
./install.sh kiro # ~/.kiro/{skills/tech-writer, agents} 에 설치 ($KIRO_HOME 존중)
./install.sh kiro --build # 설치 전 재빌드
- Claude Code:
SKILL.md가 트리거 문구로 자동 활성화되고, 메인 에이전트가 오케스트레이션을 실행한다. - Kiro CLI:
tech-writer커스텀 에이전트로 진입한다 —kiro-cli chat --agent tech-writer. 오케스트레이터가subagent도구로 워커 5종을 조율한다.
참고
- 분류 체계:
core/references/tech-doc-taxonomy.md - 작성·윤문 처방:
core/references/tech-writing-playbook.md - 슬림 룰북:
core/references/quick-rules.md
라이선스
MIT License — LICENSE 참조.