“Docs for Developers 기술 문서 작성 완벽 가이드” 는 개발자 문서를 효과적으로 작성하고 관리하는 방법을 단계별로 안내하는 탁월한 책입니다. 이 책은 구글 클라우드 문서 팀의 공동 설립자인 자레드 바티가 저술하였으며, 그는 구글 데이터 센터 환경에서 쿠버네티스, 앱 엔진, 애드센스 등 다양한 문서 프로젝트를 경험한 전문가입니다.
이 책의 원제인 "엔진니어를 위한 테크니컬 라이팅 실무 가이드" 는 실제로 테크니컬 라이팅 업무를 수행하는 전문가들을 위한 자료로서 매우 유용합니다.
책은 크게 6가지 주요 주제로 구성되어 있습니다.
첫 번째로는 문서화 계획하기 입니다. 이 단계에서는 사용자의 요구를 이해하고 문서화 계획을 세우는 방법에 대해 다룹니다. 주석 작성, README 작성, 개념 문서, 절차 문서 등 다양한 패턴을 활용하여 효과적이고 일관성 있는 문서를 작성하는 방법을 안내합니다.
두 번째로는 문서화 초안 만들기 입니다. 이 과정에서는 문서의 구조를 계획하고 초안을 작성하는 방법에 대해 상세히 설명합니다. 효과적인 문서 구조와 목차 작성, 필요한 섹션과 하위 섹션의 식별, 문서의 일관성과 흐름을 유지하는 방법 등에 대해 알려줍니다.
세 번째로는 문서 편집하기입니다. 이 단계에서는 문서를 편집하고 수정하는 과정에 대해 다룹니다. 문서의 일관성, 명확성, 표준 언어 사용, 문법 및 철자 오류 확인 등 편집의 핵심 원칙과 기술을 소개합니다.
네 번째로는 샘플 코드 통합하기 입니다. 개발자 문서에서는 종종 코드 예제가 필요한데, 이 단계에서는 문서에 적절한 코드 예제를 통합하는 방법을 다룹니다. 가독성, 유지보수 용이성, 실행 가능성 등을 고려하여 코드를 삽입하고 설명하는 방법을 설명합니다.
다섯 번째로는 문서 배포하기 입니다. 이 과정에서는 작성한 문서를 어떻게 배포할지에 대해 다룹니다. 온라인 플랫폼, 버전 관리 시스템, 도구 및 워크플로우 등을 통해 문서를 공개하고 유지 관리하는 방법을 안내합니다.
마지막으로는 문서 피드백하기 입니다. 이 단계에서는 사용자들로부터의 피드백을 수집하고 반영하는 방법을 다룹니다. 사용자 의견을 수집하고 분석하여 문서를 개선하고 업데이트하는 방법을 상세히 설명합니다.
“Docs for Developers 기술 문서 작성 완벽 가이드” 는 전문적인 테크니컬 라이팅 업무를 수행하는 사람들을 위한 필수 자료로, 개발자 문서 작성에 관심이 있는 모든 사람들에게 추천할만한 가치 있는 책입니다. 이 책을 통해 문서화 과정의 각 단계를 이해하고 습득함으로써 개발자 커뮤니티에 가치 있는 기여를 할 수 있을 것입니다.
참고
- Docs for Developers 기술 문서 작성 완벽 가이드
