프로그래머의 문서작성
설계문서, 장애 보고, 기획서 등
년차수가 올라가면 문서를 종종 작성해야 할 일이 많이 생긴다
개발 설계 문서야 PMO에서 템플릿에 가이드를 주면 개발 관련 내용을 기입하기만 하면 되는데, 가끔은 만들어 본 적이 없는 문서를 내가 생산해야 할 경우가 생긴다.
관리 업체에서 근무하던 시절엔 보통 기획서를 많이 작성했었고, 다시 본래 개발사로 돌아와 솔루션 소개서나, 정식 RFP는 아니지만 고객 요청사항에 따라 여러 문서를 만들어서 빠른 시간 안에 줘야 했다.
뭐 구글을 뒤져봐도 사실 나한테 딱 맞는 문서를 찾는데 시간도 걸리고 결국 없을 때는 작성 시간만 줄어드는 경우도 허다하다.
이건 공무원이 된 지금도 비슷하다.
7급 면접 때 보고서를 제출하고 발표하는 면접이 포함되어 있고, 7급이 되면 보고서를 많이 작성한다.
그래서 어느 정도의 나의 경험을 기록해 보고자 한다.
1. 문서의 목적을 상기한다.
기획서인데 위의 보고용으로 전체를 설명해야 하는 기획서인지, 아니면 설득용 보고서인지 판단한다.
그러면 기획의 목적과 배경, 현황과 현재 추세, 그래서 왜 이 이것이 필요한지, 그래서 무엇을 얻을 수 있는지 등을 기술하면 된다.
장애 보고서나 상황보고서는 더 심플하다. 보고 서명에서도 알 수 있듯이 상황, 원인, 해결방안, 일정, 재발방지대책이 포함될 것이다.
학업계획서는 얼마 전에 박사 지원차 작성했는데, 구글링 하다가 나만의 스타일로 작성했다.
포함 내용이야 당연히 자기소개, 지원동기, 학업계획 등은 포함하고 있지만 내용을 뻔한 내용이 아닌 나만의 내용으로 채웠다.
2. 간결하게 작성한다.
연차가 낮거나 어떤 상황에서 방안을 선택해야 하는 경험이 없을 때 작성하게 되면 대부분 필요 없는 얘기가 많다. 줄일 수 있도록 줄이되 쉽게 설명해야 하며, 빠지는 내용이 있으면 안 된다.
3. 논리를 세워라
그럼 아마 문서가 가끔 흘러가는 주제에서 다른 길로 가는 경우가 있다. 본인의 입장에서 심취하여 읽어보면 안 보이는데, 머리에서 내가 작성한 걸 잊고 읽어보면 예상외로 논리성이 없는 경우가 많다.
4. 남의 템플릿이나 스타일에 젖어들지 마라.
결국 내가 제일 자신 있게 말하고 싶은 말은 4번이다. 나는 모든 형태의 기존 틀이 맞지 않다고 생각하면 왜 이렇게 해야 하지라는 의문을 많이 가지는 성향이다. 그래서 기존 템플릿이 요청받은 경우면 맞추어 작성하지만, 없거나 그 문서가 표현해야 하는 내용이 넘치거나 빠지면 새로운 나만의 형식을 만든다. 그런데 이런 형태로 욕을 먹은 경우는 없다. 오히려 내가 만든 게 효율적인 템플릿으로 만들어진 경우가 더욱 많다.
이렇게 쓰고 나니 내가 문서를 무척 잘 만드는 사람 같지만, 나는 여전히 문서를 예쁘게 만드는 스킬은 가지고 있지는 않다. 다만 내용이 넘치거나 부족하지 않은 정도의 수준이다.
그런데 크게 스트레스를 받지는 않는다. 내가 설득하거나 보고하거나 발표할 때에 결국 내 논리가 문서에 잘 녹아져 있고, 자신 있게 발표할 수 있다면 그걸로 태클 건 사람은 한 명도 없었다
그러니 문서를 예쁘게 만드는 부분에 신경 쓰지 말고, 나만의 방식으로 내가 하고픈 주제가 잘 전달된 문서를 만드는 일에만 목적을 두면 된다.
