writer
사용자 문서, 마이그레이션 노트, 변경 사항 안내를 작성하는 Domain 에이전트.
개요
writer 에이전트는 코드가 아니라 글을 씁니다. 주력은 설명하는 작업입니다. 사용자 가이드와 API 문서, 마이그레이션 노트, 릴리스 변경 사항 정리가 여기에 들어갑니다. 무언가가 다 만들어진 뒤 그것을 남들이 알기 쉽게 풀어내는 일, 그게 이 에이전트의 몫입니다.
언제 쓰는가
- 기능 구현 후 사용자 문서나 API 레퍼런스를 작성해야 할 때
- 브레이킹 체인지가 포함된 릴리스에 마이그레이션 가이드가 필요할 때
- 변경 사항을 사용자가 이해할 수 있는 언어로 정리해야 할 때
$release스킬에서 릴리스 노트 작성이 필요할 때
사용 예시
"이 API 변경 사항을 마이그레이션 가이드로 써줘"
"새 인증 기능의 사용자 가이드를 작성해줘"
"v2에서 v3로 업그레이드하는 마이그레이션 노트를 만들어줘"작업 범위
| 항목 | 내용 |
|---|---|
| 사용자 가이드 | 기능 설명, 사용 예시, 설정 방법 |
| API 문서 | 엔드포인트, 파라미터, 응답 예시 |
| 마이그레이션 노트 | 브레이킹 체인지 목록, 업그레이드 절차 |
| 릴리스 노트 | 변경 사항 요약, 주요 기능 안내 |
작업 프로세스
- 문서화할 기능이나 변경 사항을 파악합니다.
- 독자가 누구인지(개발자, 최종 사용자 등) 확인합니다.
- 사용 예시와 함께 명확하고 실용적인 내용을 작성합니다.
- 기술 용어는 정확하게, 설명은 구체적으로 씁니다.
입력
- 문서화할 기능이나 변경 사항 설명
executor가 구현한 코드나 API 스펙- 대상 독자와 문서 목적
출력
- 사용자 가이드나 API 레퍼런스 문서
- 마이그레이션 가이드나 릴리스 노트
- 코드 예시가 포함된 실용적인 설명
제한 사항
- 코드 구현은
executor가 담당합니다. - 외부 문서 조사는
researcher에 맡깁니다. - 보안이나 성능 관련 판단은 해당 리뷰어 에이전트를 씁니다.
관련 에이전트
- executor — writer가 문서화할 구현을 담당합니다.
- researcher — 외부 레퍼런스와 공식 문서를 조사해 writer를 지원합니다.
- product-manager — 문서의 범위와 방향을 결정합니다.