기술 문서(documentation)

정의

코드나 시스템을 어떻게 쓰고 왜 그렇게 만들었는지 적어 둔 글.

자세한 설명

코드나 기능을 어떻게 쓰면 되는지, 왜 그런 방식으로 만들었는지를 다른 사람이나 미래의 자신이 알아볼 수 있게 글로 정리해 둔 것입니다. 문서가 잘 갖춰져 있으면 새로 투입된 사람이나 AI 에이전트가 처음부터 코드를 다 읽어 보지 않고도 빠르게 파악할 수 있습니다. 반면 문서가 없거나 오래돼 실제와 다르면, 오히려 잘못된 정보로 혼란을 줄 수 있습니다.

예를 들면

새 API 연동 방법을 문서로 정리해 두어, 다음에 투입된 에이전트가 처음부터 다시 조사하지 않아도 됐습니다.

관련 용어