목록docs as code (1)

Jamie the programmer

Docs as Code: API 문서화를 코드처럼 관리하는 방법

API 레퍼런스가 필요한 이유SIGDOC에서 개발자가 새로운 API를 마주했을 때 어떤 행동을 하는지를 주제로 실험을 해 본 결과 API 레퍼런스에 2번째로 가장 많이 시간을 할애한다고 합니다. API 레퍼런스 자동화 기술SwaggerJavadocAsciiDocGoDoc     자동화 기술을 사용하지 않는 이유 FeedbacksAPI 수정할 때마다 컨플문서 수정하기 너무 힘듭니다..문서는 문서대로 테스트는 포스트맨.. 관리 포인트 너무 많아..문서가 너무 무겁.. 경량화 혹은 분할 필요.스웨거, Asciidoc, 컨플루언스.. 통일화 필요!  SSG을 통한 Docs as code정의Docs as code는 기술 문서를 소스 코드처럼 취급하고 관리하는 접근법입니다.Docs like Code로도 불립니다.D..
programming/tips 2025. 3. 1. 18:19
이전 Prev 1 Next 다음