Pinterest의 Docs-as-Code 도입 노트

Pinterest의 Docs-as-Code 도입

핀터레스트 내부 개발자 설문 조사 결과, 기술 문서가 주요 문제점으로 드러났으며, 그 문제는 품질과 발견 가능성에 집중되었습니다. 문서 작성 경진 대회나 고위 리더들의 열정적인 호소와 같은 전통적인 해결책은 지속적인 개선을 가져오지 못했습니다. 2021년, 핀터레스트는 "코드로서의 문서(docs-as-code)" 전략에 초점을 맞춰 문서 도구와 프로세스를 개선하기 위한 다양한 전략을 탐색하며 새로운 접근 방식을 시도하기로 결정했습니다. PDocs라고 불리는 이 이니셔티브는 기술 문서의 품질을 향상시키고 핀터레스트의 문서화 문화를 변화시키는 것을 목표로 했습니다. "코드로서의 문서" 철학은 마크업 언어, 소스 제어, 코드 검토 도구, 정적 사이트 생성기 등을 포함하여 코드와 동일한 프로세스를 사용하여 문서를 작성하는 것을 포함합니다. 이 전략을 채택함으로써 핀터레스트는 문서 관련 문제를 해결하고, 좋은 문서 작성 관행, 품질 관리, 그리고 발견 가능성을 장려하고자 했습니다. PDocs는 맞춤형으로 제작된 정적 사이트 생성기로, 다양한 파일 경로와 저장소에서 문서 프로젝트를 자동으로 통합하여 단일 중앙 집중식 문서 사이트를 생성했습니다. PDocs는 엔지니어가 간단한 설정 파일과 Markdown 파일을 어떤 저장소에든 넣으면 병합되는 즉시 중앙 집중식 문서 사이트에 나타나도록 하는 개발자 경험을 제공합니다. PDocs UI는 프로젝트 중심적으로 설계되었으며, 즐겨찾기, 최근에 본 항목, 그리고 독자의 신뢰를 유지하기 위한 "게시됨" 또는 "초안" 설정을 포함한 기능을 제공했습니다.
CdXz5zHNQW_I5dnAJn3pO.png