Docs as Code

정의

Docs as Code는 문서를 소프트웨어 코드처럼 취급하여 버전 관리, 협업, 자동화, 리뷰, 배포 등 개발자 친화적인 방식으로 운영하는 접근 방식. Markdown, Git, CI/CD 등 개발 도구와 워크플로우를 활용한다는 점이 핵심이다. 개발 팀과 동일한 워크플로우를 따라 문서를 관리하는 철학을 의미한다.

장점

• 개발팀과 원활한 협업 가능
• 개발자가 문서 초안을 작성하는 경우가 많음
• 문서의 머지 시점을 조절할 수 있기 때문에 개발자가 개발 직후 문서를 작성하도록 유도할 수 있음
• PR 작성, 리뷰 등의 시스템 사용으로 문서의 변경 사항을 정확하게 트래킹 가능

단점

• 비개발자에게 높은 진입장벽
• 마크다운 기반
• 리뷰 사이클 길어질 수 있음 (하지만 리뷰를 아예 안하는 워드 방식보다는 낫다)
• 빌드/배포 에러 가능성