이 책을 선택한 이유

소프트웨어 개발자로 경력을 쌓아오면서 내용이 간결하고, 명확하게 잘 정리된 기술 문서를 작성해보고 싶다는 생각을 늘 가지고 있었습니다. 하지만, 생각만큼 쉬운 일은 아니었습니다. 단순히 글쓰기 실력이 뛰어나다고 좋은 기술 문서를 작성할 수 있는 것이 아니기 때문입니다.

저 뿐만 아니라 많은 개발자들이 기술 문서를 작성하는 것을 어려워하고 있는 것으로 알고 있습니다.

주변에 기술 문서 작성에 도움을 줄 수 있는 동료가 있다면 같이 협업하여 업무를 진행하면서 빠르게 배울 수 있을 것입니다. 하지만 제가 근무하는 회사와 같이 작은 개발 조직에서는 그런 동료를 만나기가 쉽지 않습니다. 그렇다고 그런 환경을 갖춘 회사로 이직하는 것도 현실적으로 쉽지 않은 문제입니다.

결국은 책을 통해서 배우는 방법을 생각할 수 밖에 없었습니다. 그래서 나에게 적합한 책이 있는지 찾아보게 되었고, 선택하게 된 책입니다.

책 소개

• 제목 : Docs for Developers
• 저자 : 자레드 버티 외 4인 지음 | 하성창 옮김
• 출판사 : 한빛미디어(주)
• 발행일 : 2023년4월10일

이 책은 '강아지 음성 번역 서비스'를 만드는 개발 팀의 스토리를 따라가며, 개발 문서를 만드는 과정을 단계별로 배우도록 구성되었습니다. 단계별 예제, 템플릿, 가이드를 통해 이론적인 내용뿐만 아니라 문서를 효과적으로 작성하고 관리하는 방법도 배우게 됩니다. 단계에 맞는 문서화 기술을 배우고, 사용자 니즈 이해부터 문서 작성, 유용한 개발자 문서 배포 및 유지까지 프로젝트 관리와 소프트웨어 개발 라이프사이클 전체를 한권에 담아 설명합니다.

이 책에서 다루는 내용은 다음과 같습니다.

• 사용자 니즈를 파악하기 위한 사용자 조사와 문서화 계획을 배워 봅니다.
• README, API문서, 튜토리얼, 개념문서, 릴리스 노트를 포함하여 다양한 종류의 문서를 조사하고, 초안을 만들어 콘텐츠를 완성해 봅니다.
• 문서 배포 후 ,사용자 피드백을 통해 콘텐츠의 품질을 유지 및 관리해 봅니다.
• 프로젝트 진행 과정을 따라가며 단계별 해야 할 업무에 대해 알아보고 적용해 봅니다.

감상평

이 책은 Corg.ly라는 서비스를 만드는 가상의 개발팀을 등장시켜서 프로젝트 진행 과정 속에서 기술 문서가 작성되고 배포되는 전체적인 흐름을 예시와 함께 설명하고 있습니다. 적절한 예시를 통해서 설명하고 있기 때문에 기술 문서 작성 방법을 배우고 이해하는데 더 효과적이었습니다.

예시가 잘 되어 있기 때문에 기술 문서 작성시 종종 참고할 수 있는 가이드가 필요하거나 이론적인 것보다는 현업에서 바로 활용할 수 있는 살아있는 기술 문서 작성 방법을 배우고 싶은 분에게는 적합한 책이 될 것 같습니다.

기술 문서를 작성하는 방법뿐만 아니라, 문서를 배포하고 관리하는 방법에 대해서도 다루고 있기 때문에 문서 관리에 관심 있으신 분들도 참고할 수 있는 책이라 생각이 들었습니다.

전체적으로 기술 문서를 작성하는 방법에 대해서 다루고 있으나, 글쓰기 그 자체에 대해서는 다루고 있지 않으니 혹시라도 글쓰기 자체를 배우고자 하시는 분에게는 적합하지 않을 수도 있습니다. 저도 이 책으로 전체적인 기술 문서 작성과 배포/관리 방법에 대한 개념을 배울 수 있었지만, 글쓰는 방법에 대해서 더 자세히 공부해보고 싶어서 추가로 다른 책을 구입해서 읽어보기로 했습니다.

책의 뒷편에는 부록으로 국내에서 활동하고 계시는 현업 테크니컬 라이터 11인의 인터뷰가 실려 있는데 개인적으로 재미있게 읽었던 부분이라고 생각됩니다. 평소 테크니컬 라이터라는 직무에 대해서는 인지하고 있었으나 자세히 알지는 못했습니다. 부록에 실려있는 인터뷰를 읽어보면서 테크니컬 라이터라는 직무에 대해서 더 자세히 알 수 있는 좋은 기회가 되었던 것 같습니다.