엔지니어링 문서를 고퀄리티로 쓰기 위한 방법(?)

퍼블리의 신규 입사자 분께 업무를 안내해드리고, 그 분을 위해서 엔지니어링 문서를 작성하는데 평소에 비해 퀄리티가 매우 높았습니다. 저를 위한 엔지니어링 문서를 쓸 때는 생략도 많고, 생략하지 말아야 할 부분도 귀찮아서 넘어가곤 했는데 다른 동료 분, 그것도 맥락을 아직 많이 가지고 있지 않은 "신규 입사자에게 안내를 드리기 위한 목적으로 엔지니어링 문서를 작성"하니까 문서의 내용에 과도한 생략이 없어지고, 같은 내용도 더 이해하기 쉽게 바뀌었습니다. 다른 사람의 작업을 참고하면서 느낀 점은 엔지니어링 문서의 독자는 해당 작업의 설계자, 실무자 뿐 아니라 미래에 해당 작업을 참고해서 같은 작업을 두 번 하지 않거나 비슷한 작업을 더 수월하게 실행하려는 다른 설계자와 실무자라는 점입니다. 후자에 해당하는 독자는 사실상 해당 작업에 대한 맥락이 적기 때문에 신규 입사자와 정도의 차이는 있으나 같은 입장입니다. 그동안은 엔지니어링 문서를 잘 작성하기 위한 방법(체크리스트, 템플릿, 프로세스 등)에 집착했었는데, 의외로 정답은 마음가짐에 있었습니다.