꿈꾸는코난

< Docs for Developers 기술 문서 작성 완벽 가이드 > | 자레스 바티 외 4인 지음 |

하성창 옮김 | 한빛미디어

개발자를 포함한 소프트웨어 엔지니어들이 가장 힘들어하는 영역중에 하나를 꼽는다면 문서 작성이라고 말할 수 있을 것 같다. 특히 개발자의 경우 일상적인 대화는 문제가 전혀 없는데 작성된 문서를 보면 많은 차이가 생기는 것을 보게 된다. 책에서도 언급이 되지만 문서 작성을 위해 워드나 한글 프로그램을 실행한 후 한동안 멍하게 있는 경우도 종종 보곤 한다. 그만큼 문서의 작성이 쉽지 않다는 것을 보여주는 것 같다.

이 책은 소프트웨어 엔지니어가 어려워하는 문서 작성에 대한 단계별 절차를 잘 설명한다. 실제 업무 환경과 유사하게 강아지 음성 번역 서비스를 개발하는 개발팀을 통해 사용자 파악, 요구사항 분석, 절차 등을 실제와 유사하게 보여준다. 특히 개략적인 설명에 끝나지 않고 필요한 요소와 이에 대한 템플릿을 같이 제시함으로 실제로 문서 작성을 시작하기 어려웠던 사람들에게 실용적인 가이드를 제시해 주고 있다.

이 책은 크게 11개의 장으로 구성되어 있다. 1장 독자 이해하기에서는 문서화를 위해 필요한 사용자 공감의 중요성에 대해 언급하며, 인터뷰, 개발자 설문조사, 고객 지원 문제 검토와 같은 사용자 조사 및 도구를 사용할 수 있음을 설명한다. 특히 사용자의 경험에 대한 마찰 로그를 문서화하고 이를 통해 사용자와 공감하는 것이 중요하다는 것을 잘 보여준다. 2장 문서화 계획하기에서는 만들어야하는 콘텐츠 및 컨텐츠 유형을 문서 작성에 앞서 설명하는 것이다. 문서화 계획은 사용자가 필요로 하는 콘텐츠의 유연한 밑그림 역할을 하면서 소프트웨어 엔지니어가 가장 중요한 문서를 작성하는데 집중할 수 있도록 해 준다.

3장 문서 초안 만들기에서는 편안하고 친숙한 문서 작성 도구를 선택하여 성공적인 글쓰기 준비를 도와주며, 4장 문서 편집하기에서는 작성된 초안을 기반으로 정확성,  완결성, 구조, 간결성, 명확성을 높이는 방향으로 진행되며 특히 동료 검토 및 피드백의 중요성에 대해 잘 알 수 있다. 이어지는 모든 장에서도 각 단계에 맞는 적절한 문서 단계에 대해 설명한다. 특히 10장 문서 구조화하기와 11장 문서 유지 관리 및 지원 중단하기는 문서를 작성한 후 관리를 위해 필요한 여러 단계 및 계획에 대해 잘 설명하고 있다.

문서 작성에 대해 어려움을 느끼거나 거부감을 느끼는 사람도 많은 것 같다. 이는 문서 작성 자체에 대한 어려움보다 제대로된 문서 작성 경험 부족과 제대로 된 절차를 잘 알지 못해 생기는 경우가 더 많다는 생각이 든다. 문서 작성에 어려움을 느끼고 있는 소프트웨어 엔지니어라면 이 책을 통해 문서 울렁증에서 벗어날 수 있는 계기가 될 수 있을 것 같다.

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