문서, 어떻게 관리해야할까요?
API 엔드포인트 문서는 초기 구현 단계에서 에이전트의 정확도를 높이는 데 유용하지만, 코드에서 파생 가능한 정보는 중복 관리 비용을 유발하므로 구현 완료 후 삭제해야 합니다. 이는 유지보수성을 향상시키는 방법입니다.
핵심 요약
- 문서화되어야 할 모든 것이 문서화되었는지, 그리고 문서화되지 않아야 할 것이 문서화되지 않았는지 확인하는 두 가지 점검이 중요합니다.
- API 엔드포인트 문서는 초기 구현 후 삭제해야 합니다. API 엔드포인트 목록은 코드에서 파생 가능한 정보이기 때문입니다.
- 코드에 이미 있는 정보가 문서에도 존재하면, 두 곳에 중복 데이터가 발생하여 나중에 불일치가 발생할 수 있습니다.
전체 요약과 종목별 의견·실시간 분석을 보려면 로그인하세요.
로그인 / 회원가입