<Docs for Developers 기술 문서 작성 완벽 가이드> 리뷰

 

이 책을 보고 든 생각은 이제는  좋은 글, 도움이 되는 글 쓰는 것 자체도 코드를 작성하고, 구조를 고민하고 프로그래밍을 하는 것 만큼 쉽지 않은 것이다. 라는 생각이 들었다.

 

처음에는 기술관련 개인 기록용으로 시작했던 블로그가 점점 보는 사람들이 미세하게 나마 많아지면서 기술 문서처럼 되었으면 하는 바램이 0.001%(?) 정도 증가하면서 관심가져 보게 된 책이다.

 

"... 이 책의 원서에는 '엔지니어를 위한 테크니컬 라이팅 실무 가이드' 라는 부제가 붙어 있습니다. '테크니컬 라이팅'은 기술 문서를 작성하는 일로, 이 책은 소프트웨어 개발자를 위한 테크니컬 라이팅 안내서라고 할 수 있습니다...."

 

 

 

이 책은 아래의 챕터들을 가지고 있고, 가상의 서비스 Corg.ly 라는 걸 만드는 개발 팀에 대한 이야기로 만들었다고 한다.

 

챕터 1 - 독자 이해하기
챕터 2 - 문서화 계획하기
챕터 3 - 문서 초안 만들기
챕터 4 - 문서 편집하기
챕터 5 - 샘플 코드 통합하기
챕터 6 - 시각적 콘텐츠 추가하기
챕터 7 - 문서 배포하기
챕터 8 - 피드백 수집하고 통합하기
챕터 9 - 문서 품질 수정하기
챕터 10 - 문서 구조화 하기
챕터 11 - 문서 유지 관리 및 지원 중단하기

부록A - 국내 테크니컬 라이팅은 어떨까요?
부록B - 전문가를 고용해야 하는 이유
부록C - 참고 자료

 

그러면서 겪게 되는 과정들에 대한 고민들과, 그런 고민들에 대한 부분들을 세세하게 나눠서 알려준다.

그러면서 테크니컬 라이터라는 전문직업이 회사 마다 있다는것도 알게 되서 신기했다.

 

 

기술 문서를 쓰는 방법, 국내외 테크니컬 라이터분들과의 인터뷰 등을 볼 수 있고, 이런 쪽으로 관심이 있다고 한다면 도움이 될 듯 하다

"...문서의 대상, 목적, 패턴을 정의하는 것으로 시작하세요. 문서의 목표가 문서의 제목에서 드러나야 합니다.. (챕터 3 문서 초안 만들기) 중 일부"

 

테크니컬 라이트에 대해 참고 영상:

https://www.youtube.com/watch?v=95E0EbHo2xQ&ab_channel=%EB%9D%BC%EC%9D%B8%EA%B0%9C%EB%B0%9C%EC%8B%A4%EB%A1%9D 

 

 

 

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