문서를 작성해보신 적 있나요?
인적 사항을 적는 문서 외에 회사에서 처음 작성한 문서는 일일보고서였죠 당시의 보고서는 자동으로 생성 했었지만 최신화되지 않아 수동으로 추가 기입해줘야 했습니다.
두번째는 작업계획서 였습니다. 승인을 받아야 서버에 변경사항을 적용할 수 있었거든요.
정해진 양식에 뭘 왜 해야 하는지 적는 문서였습니다.
세번째로 처음 양식이 없는 문서를 작성했는데 프로그램 사용 메뉴얼 이었습니다.
당시에는 기획자도 없었고 기획이라고 해봐야 개발하기 전에 PPT로 그려보는게 다였죠.
무슨 문서를 작성하던 전 쓸데 없이 긴 문장을 좋아하지 않습니다.
그래서 여기와서도 기존 문서들을 싹 다 고쳤고요.
그래서 글을 재미있게 쓰는 재주는 없습니다.
어떤 문서가 잘 쓴 문서일까요?
흔히 나갈 때가 되어서 업무 인계를 위한 문서를 작성할 때면
아무나 보고 따라할 수 있게 라는 주문을 하곤 합니다.
그러나 막상 문서를 작성하면 어떤 부분을 보완해달라거나 잘 이해가 되지 않는 다는 얘기는 들어본 적이 없습니다.
제가 잘 썼거나 말만 그렇게 하고 보지도 않는 것이겠죠.
애초에 아무나의 범위는 어디까지 일까요?
이 글은 문서를 어떻게 써야 독자의 이해를 도울 수 있는지 기술 문서를 작성할 때 유의해할 점에 대해 알려줍니다.