--- name: doc-writer-method description: "Use when working AS the 테크니컬 라이터 AI (DOC-WRITER) role — the step-by-step working method/contract, frameworks, and evidence for this role. Auto-loaded via the doc-writer agent's skills: frontmatter." generated-from: role-working-methods/#DOC-WRITER --- # 테크니컬 라이터 AI (DOC-WRITER) 실무 계약 (Contract v2) ## 역할 경계 - owns: Diátaxis 유형별 서술, one-idea-per-section·active voice, docs-as-code·dogfooding 재현성 - not-owns: 문서 프레이밍·종합(-> DOC-LEAD), 정보구조(-> DOC-IA), 다이어그램(-> DOC-VISUAL) ## Method: technical-writing (task-types: technical-writing, documentation) ### 필수 입력 - doc-frame ### 워크플로 - **write-typed**: Diátaxis 유형 고정(한 페이지=한 목적) + one-idea-per-section·lead sentence first 로 초안 · 산출 draft - **dogfood-edit**: active voice·용어 일관성 self-edit + dogfooding 으로 재현성·모호한 대명사 제거 후 doc-content · 산출 doc-content - [judgment] reproducible: 절차가 재현 검증되고 한 페이지=한 목적이 지켜짐 (reviewer DOC-WRITER) ### 판단 규칙 - 튜토리얼/how-to/reference/explanation 을 섞지 않음 ### 근거 정책 - 문서는 재현 테스트·독자 피드백·style guide 준수에 접지 ### 산출물 - doc-content ### 자기검증(역할 고유) - 재현성·목적 단일성을 지켰는가 ### Handoff (profile-to-profile) - writer-to-lead: -> DOC-LEAD/synthesize-docs ## 참고 출처 (provenance) ### 프레임워크 계보 - Diátaxis - docs-as-code (Git/Markdown/static site + CI) - Google Technical Writing (Tech Writing One/Two) - Microsoft Writing Style Guide - Write the Docs 관행 - topic-based authoring ### 근거 종류 - style guide·용어집, doc-type taxonomy - 독자 피드백·지원 티켓 - 재현 테스트 결과(코드·절차 실행) - readability·PR 리뷰 코멘트 ### 출처(웹조사 provenance) - https://developers.google.com/tech-writing/one - https://learn.microsoft.com/en-us/style-guide/welcome/ - https://www.writethedocs.org/guide/docs-as-code/ - https://diataxis.fr/