claude-interactive-documentation-workflo은(는) 무엇을 하나요?
📝 구조화된 워크플로를 통해 기술 문서화와 구현을 간소화하고, AI를 활용하여 명확성을 높이고 기술 부채를 줄입니다.
이 스킬은 개발자와 기술 작가가 AI 에이전트와 협력하여 기술 문서를 효율적으로 생성, 유지보수 및 개선할 수 있는 방법을 제공합니다. 다음은 주요 워크플로 단계입니다:
- 문서 계획: 프로젝트 요구사항을 분석하고 문서 범위를 정의합니다.
- 템플릿 기반 작성: 미리 정의된 템플릿을 사용하여 일관된 형식의 문서를 작성합니다.
- AI 검토 및 피드백: AI가 문서의 명확성, 정확성, 완전성을 검토하고 개선 제안을 제공합니다.
- 코드-문서 동기화: 코드 변경 사항을 문서에 자동 반영하여 최신 상태를 유지합니다.
- 최종 검증: 문서가 모든 요구사항을 충족하는지 확인하고 승인합니다.
지원 플랫폼
- Claude Code: 워크플로우를 직접 실행하고 AI 피드백을 받을 수 있습니다.
- Cursor: 코드 편집기 내에서 문서화 작업을 통합할 수 있습니다.
- 기타 AI 도구: 유사한 기능을 제공하는 다른 에이전트와도 호환 가능합니다.
사용 예시
# 문서 계획 생성
documentation-workflow plan --project my-app --scope api
# 템플릿 기반 문서 작성
documentation-workflow generate --template api-docs --output docs/api.md
# 문서 검토 요청
documentation-workflow review --file docs/api.md
환경 변수
DOCS_WORKFLOW_DIR: 문서 작업 디렉토리 경로 (기본값:./docs)DOCS_TEMPLATE_DIR: 템플릿 디렉토리 경로 (기본값:./templates/docs)
라이선스
MIT