We started writing docs for AI agents, not humans — and made it an open standard

개요

AI 에이전트가 코딩 작업을 수행하는 사례가 증가함에 따라, 개발자 도구 제공업체는 인간 독자뿐만 아니라 AI 에이전트를 위한 기술 문서를 새롭게 작성하고 이를 오픈 표준으로 공개했습니다.

주요 내용

• AI 에이전트의 문서 소비 증가: 개발자 도구 사용자들이 브라우저 대신 AI 코딩 에이전트를 통해 도구를 프로젝트에 추가하고 설치 및 설정을 진행하는 사례가 늘고 있습니다.
• 기존 문서의 한계: 인간 독자를 대상으로 작성된 기존 문서는 AI 에이전트가 정보를 추론하고 정확한 사실을 파악하는 데 비효율적이며, 에이전트가 잘못된 설정을 하거나 존재하지 않는 기능을 호출하는 원인이 되었습니다.
• AI 에이전트 전용 문서 도입: 각 릴리스마다 documentation.ai.md라는 두 번째 파일을 발행하기 시작했으며, 이는 인간 독자용 문서의 요약이 아니라 AI 에이전트가 제품을 설치, 구성 및 호출하는 데 필요한 모든 정보를 담고 있는 독립적인 문서입니다.
• AI 에이전트 문서의 특징:
• 정확하고 완전한 정보 제공: 제품 ID, 설치/실행 명령어, 구성 변수, API 예시(가짜 코드가 아닌 실제 요청/응답), 관리 기능, 아키텍처 정보, 링크 등을 포함합니다.
• 마케팅 언어 배제 및 솔직한 상태 명시: 제품의 초기 단계 또는 미감사 상태를 명확히 표기하여 에이전트가 불안정한 기능을 추천하는 것을 방지합니다.
• llms.txt와의 차별점: llms.txt가 콘텐츠의 색인 역할을 한다면, documentation.ai.md는 제품별, 릴리스별 운영 문서로서 완전한 정보를 제공하는 데 중점을 둡니다.
• 오픈 표준으로의 공개: documentation.ai.md 표준은 CC BY 4.0 라이선스로 공개되어 다른 개발자 도구 제공업체도 채택할 수 있도록 했습니다.

시사점

AI 에이전트가 개발 도구 설치 및 통합 과정에 점점 더 많이 사용됨에 따라, 개발자 도구 제공업체는 AI 에이전트가 이해하고 실행할 수 있는 정확하고 완전한 기술 문서를 작성하는 것이 필수적이며, 이를 위한 오픈 표준의 채택은 효율성과 사용자 경험을 크게 향상시킬 수 있습니다.