Quack Docs — 터미널에서 AI로 생성되는 코드 문서화 도구
카테고리
프로그래밍/소프트웨어 개발
서브카테고리
개발 툴
대상자
- 대상: Python 개발자 및 CLI 도구 사용자
- 난이도: 중간 (기본적인 터미널 사용 능력 필요)
핵심 요약
Amazon Q Developer CLI
를 활용해 한 번의 명령어로 완전한 Markdown 문서 또는 코드 내 인라인 주석 생성- 코드 분할 없이 전체 파일을 처리하며,
--inplace
옵션으로 원본 파일에 주석 추가 가능 - Python 기반 CLI 도구로,
python main.py --file
명령어 사용
섹션별 세부 요약
- 💡 The Idea
- 개발자가 문서화 작업을 하기 싫은 현실을 반영한 아이디어 제시
- "터미널에서 즉시 생성"이라는 핵심 가치 강조
- Markdown 문서 또는 인라인 주석 두 가지 방식 지원
- 🤖 How It Works
- 1. 코드 파일 읽기 → 전체 파일을 분할 없이 처리
- 2. 출력 모드 결정 →
--inplace
사용 시 원본 파일에 주석 삽입 - 3. Amazon Q CLI에 요청 전송 → 생성된 문서를
.md
파일 또는 수정된 코드 파일로 저장
- 🚀 Getting Started
- GitHub에서 소스 코드 클론 후
make install
명령어 실행 - AWS 인증 (
q login
) 및python main.py --file
명령어로 문서 생성
- 🧪 Usage
- 기본 사용법:
python main.py --file path/to/your_file.py
- 인라인 주석 추가:
--inplace
옵션 추가 시add
함수에 자동 주석 삽입 - 예시 출력:
docs/quack_calculator_20250510_103000.md
파일 생성
- ✨ Why You'll Love It
- 문서화 과정 자동화로 개발자 시간 절약
- Markdown 구조 및 인라인 주석 두 가지 방식으로 유연한 사용 가능
- 터미널 내 애니메이션 및 덕(duck) 테마 UI로 사용자 경험 강화
- 🔭 What’s Next
- 문서 커버리지 통계 제공 예정
- VS Code 확장 프로그램 지원 추가 예정
- 터미널 내 애니메이션 기능 도입 계획
- 🧠 Final Thoughts
- AWS와 DEV의 협업 프로젝트로 개발자 생산성 향상에 기여
- Amazon Q Developer CLI와의 결합으로 문서화 프로세스 효율화
결론
- "python main.py --file" 명령어로 즉시 문서 생성 가능
- 인라인 주석 추가 시
--inplace
옵션 사용이 필수 - VS Code 확장 프로그램 지원 확대 및 애니메이션 기능 추가 예정으로 지속적인 개선 예상