Oh-my-toong-playground technical-writing
Use when reviewing, improving, or writing technical documentation in Korean. Triggers include "문서 리뷰", "테크니컬 라이팅", "기술 문서", "문서 개선", "writing review", "doc review"
install
source · Clone the upstream repo
git clone https://github.com/toongri/oh-my-toong-playground
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/toongri/oh-my-toong-playground "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/technical-writing" ~/.claude/skills/toongri-oh-my-toong-playground-technical-writing && rm -rf "$T"
manifest:
skills/technical-writing/SKILL.mdsource content
Technical Writing Review
Reviews technical documents and suggests improvements. 3-phase sequential review: Type Classification → Information Architecture → Sentence Refinement.
The Iron Law
- Perform all 3 Review Areas in order. Do not skip any Area.
- After completing each Area, present review results to the user and get approval.
- All principles are recommendations. Apply flexibly based on context.
Non-Negotiable Rules
| Rule | Description |
|---|---|
| Sequential Execution | Type → Architecture → Sentence order |
| Per-Area Approval | User confirmation after each Area |
| Before/After | All improvement suggestions in Before/After format |
| Cite Principle | Each suggestion must cite its principle ID (T1 |
Review Areas
digraph review_flow { rankdir=LR; node [shape=box]; "Input Document" -> "Area 1:\nType Classification"; "Area 1:\nType Classification" -> "Area 2:\nArchitecture Review"; "Area 2:\nArchitecture Review" -> "Area 3:\nSentence Review"; "Area 3:\nSentence Review" -> "Review Complete"; }
Area 1: Type Classification
- Reviews: Document type classification, required elements verification per type
- Enter when: Review target document exists
- Skip when: User already specified type and requested no type verification
- Reference:
references/type.md
Area 2: Architecture Review
- Reviews: Headings, overview, page structure, predictability, value-first, background explanation
- Enter when: Area 1 completed
- Skip when: Only sentence-level review requested
- Reference:
references/architecture.md
Area 3: Sentence Review
- Reviews: Subject clarity, conciseness, specificity, consistency, Korean naturalness
- Enter when: Area 2 completed (or Area 1 if Area 2 skipped)
- Skip when: Only structure-level review requested
- Reference:
references/sentence.md
Review Output Format
Each Area's review results use this format:
## Area N: {Area Name} Review ### Summary - 총 {N}건의 개선 제안 - 심각도: Critical {N} / Suggestion {N} ### Findings #### Finding 1: {제목} - **원칙**: {원칙 ID} - {원칙 이름} - **심각도**: Critical / Suggestion - **Before**: > {원본 텍스트} - **After**: > {개선된 텍스트} - **근거**: {왜 이 변경이 필요한지}
Severity criteria:
- Critical: Reader may misunderstand or fail to find information (missing subject, no overview, type mismatch)
- Suggestion: Readability/naturalness improvement (meta-discourse, translationese, conciseness)
Area Completion Protocol
After completing each Area:
- Present review results in Review Output Format
- Ask user: "Area N 리뷰 결과를 확인해주세요. 다음 Area로 진행할까요?"
- Proceed to next Area after user approval
Review Completion
After all 3 Areas are complete:
- Present overall review summary (finding count per Area, Critical/Suggestion ratio)
- Priority-ordered improvement list (Critical → Suggestion)
- Generate improved full document upon user request
Language
- Review results are written in Korean
- Principle IDs remain in English codes (T1, P1, etc.)
- Before/After examples maintain the original language