본문 바로가기

책을 보다

[리뷰] 사람을 향하는 <Docs for Developers 기술 문서 작성 완벽 가이드>

학습이 아닌 경험으로 알게 된 내용을 잘 정리하여 풀어놓은 듯한 느낌을 받습니다.

너무 와닿는 내용들이라 알려준 대로 따라가기만 하면 좋은 문서를 만들 수 있을 것 같습니다.

하지만, 반드시 모든 단계를 따라갈 필요는 없다는 생각도 듭니다. 책에서 문장으로 표현하지는 않았지만 읽으면서 자연스럽게 알 수 있습니다.

무엇보다 문서를 만드는 게 먼저입니다. 책에 나오는 얘기이기도 합니다만, 기능이 구조보다 우선해야 하기 때문입니다.

좋은 문서라면 나오기까지 걸맞은 단계를 거쳤을 가능성이 큽니다. 그렇다고 해서 문서를 만들기 위한 프로세스에 너무 매달리면 프로세스에 묶여 문서가 나오지 않는 불상사가 생길 수 있기 때문입니다.

 

의견을 들어야 한다

지식의 저주로 시작하여 내용을 풀어나가기 시작합니다.

첫 부분에 지식의 저주가 등장하는 게 이 책이 무엇을 얘기하고 싶은 건지 한마디로 알려준다고 생각합니다.

같은 문장을 보더라도 사람마다 그리는 이미지, 이해하는 정도가 모두 다릅니다. 그렇기에 매 단계마다 서로가 이해하는 바를 조율할 필요가 있습니다.

처음부터 끝까지 모든 단원에 의견을 들어야 하는 순간이 있습니다.

 

혼자가 아니다

홀로 존재하는 문서는 있을 수 없습니다. 더욱이 기술 문서는 하나로 모든 것을 설명할 수 없습니다.

관련 문서 가운데 자기 위치가 어디이고 어디로 이어져야 하는지 알려야 합니다.

그렇지 않다면 독자가 읽을수록 헤매게 될 가능성이 다분한 분야이기 때문입니다.

독자가 원하는 정보에 쉽게 접근할 수 있도록 잘 짜여야 합니다. 언제든지 쉽게 정확한 길을 볼 수 있어야 합니다.

혼자가 아니기에 든든하지만, 오합지졸이 되어서는 안 된다고 얘기합니다.

 

수명이 있다

설명하는 내용에 따라 계속 업데이트해야 합니다. 당연하다고 알고 있지만 실행하기는 만만치 않습니다.

맞지 않는 문서는 없느니만 못합니다. 시간 낭비부터 시작하여 오작동까지 다양한 문제를 일으킬 수 있습니다.

가장 치명적인 건 신뢰를 무너뜨린다는 겁니다.

문서가 사람과 기술을 이어주는 역할을 하는 것처럼 보이지만, 결국은 사람과 사람을 연결합니다.

그렇기에 문서로 이어지는 암묵적인 신뢰가 무너져서는 안 됩니다.

만들고 있는 문서가 어떤 문서인지 항상 명심해야 합니다. 영원히 남을 작품을 만드는 게 아닙니다. 영원히 남아서도 안되고요.

역할에 충실해야 하며, 역할을 다하는 순간 사라져야 하는 문서임을 잊지 말아야 합니다.

 

 

동영상은 문서만큼 효율적이지 않다고 생각합니다.

필요한 부분을 찾기도 어렵고, 원하는 내용이 나오기까지 계속 기다려야 합니다. 이렇게 기다리다 잠드는 경우도 허다하고요. 그렇기에 잘 만들어진 문서를 만나면 핵심부터 살펴볼 수 있기에 만든 이에게 고마울 따름입니다.

 

책을 읽으면 읽을수록 사람을 더 생각하게 됩니다.

문서를 만드는 사람, 관리하는 사람, 읽는 사람. 문서가 널리 알려졌으면 하는 마음으로 소문내는 사람까지.

 

 

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

 

반응형