Docs for Developers 기술 문서 작성 완벽 가이드(한빛미디어)

#2330

굳이 테크니컬 라이터가 아니더라도 실제로 업무와 관련된 각종 다양한 문서를 작성하는 포지션에 있는 사람이라면 누구나 읽어 볼 가치가 충분한 책이라 생각된다. IT관련자라면 더욱 도움이 되겠지만 비관련자라도 작업자 간에 정보공유를 위한 문서를 작성하고 있거나 이제부터라도 작성해야 하는 이라면 누구나 대상이 될 수 있는 책이다.

# 기술 문서 작성

혼자 일을 할 경우, 다음에 일하게 될 직위, 경력등 불특정된 후임을 위한 문서를 작성해 두는 편이다.

팀으로 일할 경우 선행 작업으로 알게 된 각종 내용, 사전지식 등을 공유하기 위한 작업자들을 위한 배포문서를 작업할 때도 유용한 내용들로 이루어져 있다.

지금까지의 경험상 대체로 이러한 문서를 접하는 작업자들은 읽고 지나치면서 제대로 된 피드백을 제공하지 않는 경향이 있어서 문서의 질을 높이는 것이 힘든 편이다. 문서의 중요성은 누구나 알지만, 문서를 만드는데 들여야 하는 절대적 시간에 대해서는 누구나 시간을 할애하는데 인색한 편이다. 말하기는 쉬워도 실제로 손을 움직이는 건 어려우니까.

그럼에도 문서를 솔선해서 작업하는 이유는 나름의 업무를 대하는 자세, 혹은 개인적인 폴리시라고 생각한다. 프로젝트 특성상 대부분 오픈되는 문서가 아니기 때문에 대외적인 평가를 받기도 힘들고 일부는 있는지도 모르고 관심 없는 문서로 취급받지만 어느 순간 미약하게나마 누군가에게 도움이 된다면 좋을 것 같다.

# Docs for Developers 기술 문서 작성 완벽 가이드

문서를 작성하는데 걸리는 시간은 상당한 시간을 요하고 있지만 일반적으로 문서가 가지는 중요성에 대해서는 약간 간과되고 있는 경향이 없잖아 있다.

경험상 다들 귀찮은 작업이고 일반적으로 프로젝트의 종료시점에 필요한 산출물이나 요청에 의한 작업, 후임이나 동료를 위한 가이드 형식의 짤막한 문장으로 이루어진 Readme가 일반적인 문서 형식이다.

책에서 다루고 있는 기술문서의 개요, 필요성, 바른 작성 및 운용방법 등 읽을거리가 풍부해서 읽는 재미가 있었다. 글을 쓰는 작업을 좋아하거나 누군가에게 도움을 주고 싶거나 바른 문서를 작업하려는 목표가 있거나 정리정돈을 좋아하는 사람이라면 읽어 보면 어떨까 생각된다.

짤막한 정보라도 없는 것보다는 있는 것이 문서를 작성한 당사자가 없더라도 프로젝트를 이어받아 작업하는 누군가에게 기본적으로 인지하고 있어야 하는 작업당시의 정보를 남기는 건 도움이 된다는 것을 알고 있기에 가급적 업무가 바쁘더라도 문서를 작성해서 정리해 두려는 개인적인 행동이 틀리지 않았다는 것을 책을 읽으며 은연중에 느낄 수 있었다. 어디까지나 자기만족이긴 하지만.

# 마무리

지금 당장 진행중인 프로젝트에 업무와 관련된 가이드 문서가 없다면 책을 통해 알게 된 10분의 1정도의 지식만 활용해서, 최소한의 규칙과 방법을 만들어서 공유해 보길 바란다. 주변의 평가가 달라질 거라 생각된다. 일부는 고마워하고 일부는 쓸데없는 짓을 했다고 하겠지만 후자의 경우는 앞으로도 굳이 상종할 필요는 없는 부류라 생각해도 좋을 것 같다.

---

한빛미디어 <나는 리뷰어다> 활동을 위해서 책을 제공받아 작성된 서평입니다.

---

소프트웨어 개발자를 안내하는 테크니컬 라이팅을 위한 실무 노트우아한형제들, 카카오, AWS, LINE Plus, 쿠팡, NHN, 데브시스터즈, 넷마블 등 국내 테크니컬 라이터 11인 인터뷰 특별 수록!이 책은 ‘강아지 음성 번역 서비스’를 만드는 개발 팀의 스토리를 따라가며, 개발 문서를 만드는 과정을 단계별로 배우도록 구성...