🧑💻 오늘의 개발하면서 생긴 크고 작은 이슈사항을 기록해주세요
💚 어떤 기능인가요?
API 문서 산출물(asciidoc/html/pdf) 관리 정책을 확정하고, 문서 생성 파이프라인과 저장소 상태를 일관화하는 작업입니다. 현재 산출물 삭제 변경이 워킹트리에 남아 있어 관리 정책 불일치가 드러난 상태입니다.
상세 배경
src/docs/asciidoc 및 템플릿 파일 관리 정책이 불명확- 생성 산출물을 버전관리할지, 생성물로만 다룰지 기준 부재
- 스크립트/입력(
swagger.json)과 결과물 동기화 기준 필요
기대 효과
- 문서 관련 불필요한 diff 감소
- CI/CD에서 문서 생성 검증 신뢰도 향상
- 팀원 간 문서 운영 방식 일치
✅ To Dos
완료 조건
- 문서 생성/관리 정책이 문서화되어 누구나 동일하게 수행 가능
- 문서 산출물 관련 충돌/노이즈 diff 대폭 감소
- CI에서 문서 정합성 검증 가능
🧑💻 오늘의 개발하면서 생긴 크고 작은 이슈사항을 기록해주세요
💚 어떤 기능인가요?
API 문서 산출물(asciidoc/html/pdf) 관리 정책을 확정하고, 문서 생성 파이프라인과 저장소 상태를 일관화하는 작업입니다. 현재 산출물 삭제 변경이 워킹트리에 남아 있어 관리 정책 불일치가 드러난 상태입니다.
상세 배경
src/docs/asciidoc및 템플릿 파일 관리 정책이 불명확swagger.json)과 결과물 동기화 기준 필요기대 효과
✅ To Dos
generate-asciidoc.sh실행 결과와 저장소 정책 정합성 점검swagger.json입력 변경 시 문서 갱신 절차 정의.gitignore/문서 가이드 업데이트완료 조건