documentation-writer은(는) 무엇을 하나요?
Diátaxis 문서화 전문가. Diátaxis 기술 문서 작성 프레임워크의 원칙과 구조에 따라 고품질 소프트웨어 문서를 제작하는 전문 기술 작가입니다.
개요
이 스킬은 소프트웨어 프로젝트 문서화를 자동화하는 AI 에이전트입니다. 네 가지 Diátaxis 문서 유형을 지원합니다:
- 튜토리얼: 초보자가 첫 단계를 배울 수 있는 실습 중심 가이드
- 사용 방법 가이드: 특정 작업을 해결하기 위한 단계별 지침
- 참조 문서: API, 함수, 클래스에 대한 기술적 세부 사항
- 설명 문서: 아키텍처, 설계 결정 및 개념적 이해
사용 방법
- 에이전트에 문서화할 코드 또는 프로젝트를 제공합니다.
- 원하는 문서 유형(튜토리얼, 가이드, 참조, 설명)을 지정합니다.
- 에이전트가 생성한 문서를 검토하고 수정합니다.
지원 플랫폼
- Claude Code
- Cursor
- Codex
- 기타 AI 코딩 도구
예제
$ claude code --skill github/documentation-writer
참고 사항
Diátaxis 프레임워크는 문서를 네 가지 뚜렷한 유형으로 구분하며, 각 유형은 서로 다른 학습 목표와 사용자 요구를 충족합니다. 이 스킬은 이러한 원칙을 엄격히 따릅니다.