기술 문서 작성 완벽 가이드?

Docs for Developers 기술 문서 작성 완벽 가이드 - 우아한형제들 카카오 등 국내 테크니컬 라이터 11인 인터뷰 특별 수록
자레드 바티 외 지음, 하성창 옮김 / 한빛미디어 / 2023년 4월

저자

자레드 바티, 재커리 사라 콜라이센 외 3명

#책소개

소프트웨어 개발자를 안내하는 테크니컬 라이팅을 위한 실무 노트
우아한형제들, 카카오, AWS, LINE Plus, 쿠팡, NHN, 데브시스터즈, 넷마블 등 국내 테크니컬 라이터 11인 인터뷰 특별 수록!

이 책은 ‘강아지 음성 번역 서비스’를 만드는 개발 팀의 스토리를 따라가며, 개발 문서를 만드는 과정을 단계별로 배우도록 구성되었습니다.

단계별 예제, 템플릿, 가이드를 통해 이론적인 내용뿐만 아니라 문서를 효과적으로 작성하고 관리하는 방법도 배우게 됩니다.

단계에 맞는 문서화 기술을 배우고, 사용자 니즈 이해부터 문서 작성, 유용한 개발자 문서 배포 및 유지까지 프로젝트 관리와와 소프트웨어 개발 라이프사이클 전체를 한 권에 담아 설명합니다.
또한 부록에는 우아한형제들, LINE Plus, 카카오엔터프라이즈, NHN 클라우드, 넷마블, 데브시스터즈, AWS, 쿠팡에서 활동하는 국내 유명 테크니컬 라이터 11인의 인터뷰가 수록되었습니다.

테크니컬 라이팅이 무엇인지, 업계에서 테크니컬 라이터의 역할에 대해 설명합니다. 이미 테크니컬 라이팅의 세계를 경험한 선배들의 다양한 경험과 이야기를 들을 수 있습니다.

라고 말하더라.

---

# 이 책의 특징

1. 구성

구성은 왠지는 모르겠지만 조금 산만하다.

내용을 이해하려면 집중해야 한다.

또한 구성이 그렇게 읽기 쉽지는 않다.

2. 기술 위주

당연히 개발자를 위해서 적는 것은 당연하지만

조금 일반적인 글을 쓰고 그 다음 개발자를 위한 글을 쓰는 것도 좋았을 것 같다.

3. 실제 경험담 위주

당연히 경험이 많은 사람들이 썼기 때문에 정말 잘 쓴 것 처럼 보이지만..이것을 일반인이 읽는다고 했을때도 구성이 비슷해야 잘읽히는가? 는 조금 고민해야 할듯

---

#후기

솔직히 다 집중해서 읽진 못했다.

하지만 재밌게 읽은 것은 사실이다.

내가 지금까지 글을 어떻게 썼는지, 어떻게 써야할지 많이 반성을 하게 된다.

아직 이러한 것을 적용해서 글을 쓰지 않았지만

써보려고 한다.