Docs for Developers 기술 문서 작성 완벽 가이드

특별 부록 : 국내 테크니컬 라이터 11인 인터뷰
「자꾸 쓰다 보면 잘 쓸 수 있습니다」
- 유영경 〈우아한 형제들〉

「기술 문서를 책임지는 사람들, 테크니컬 라이터」
- 김유리 〈카카오엔터프라이즈〉

「AWS 머신러닝 테크니컬 라이터가 된 천체물리학 박사의 이야기」
- 최미영 〈AWS〉

「2세대 테크니컬 라이터의 이야기」
- 전정은 〈LINE Plus〉

「테크니컬 라이터가 가져야 하는 자세」
- 임근희 〈쿠팡〉

「직업으로서의 테크니컬 라이터」
- 박선영 〈NHN 클라우드〉

「LINE에서 테크니컬 라이터가 하는 일」
- 이인실 〈LINE Plus〉

「테크니컬 라이터의 자세」
- 남정현 〈데브시스터즈〉

「IT 기업 테크니컬 라이터의 경험과 짧은 소회」
- 강정일 〈LINE Plus〉

「테크니컬 라이터의 이야기」
- 이중민 〈넷마블〉

「테크니컬 라이터도 그냥 흔한 동료 중 한 명입니다」
- 조병승 〈넷마블〉

개발 생태계 모든 사람을 위한
이야기로 배우는 기술 문서 작성법

좋은 문서화와 프로그래밍을 통합하는 것은 중요합니다. 문서화가 잘된 프로젝트는 개발자와 사용자 모두에게 도움을 줍니다. 적절한 기술 문서가 없는 프로젝트에서는 개발자 생산성, 프로젝트 확장성, 사용자의 제품 채택률과 접근성이 저하될 뿐만 아니라 프로젝트 성공 확률까지 낮아집니다. 그만큼 프로젝트 진행에 있어 좋은 문서화는 필수 조건입니다.

이 책은 가상의 소프트웨어 개발 팀이 새 제품을 출시하는 과정에 따라 개발자 문서를 만드는 과정을 설명합니다. 사용자의 니즈를 조사하고, 일반적인 문서화 패턴에 따라 계획 수립부터 콘텐츠 초안 작성과 편집 후 배포하는 과정까지 알려줍니다. 배포 후에도 피드백을 취합하고, 문서의 유효성을 측정하는 등 문서의 규모가 커짐에 따라 유지 관리하는 데 필요한 실용적인 조언을 함께 제공합니다.

또한 원서에는 담기지 않았던 국내 유명 테크니컬 라이터 11인의 인터뷰를 수록하여, 다양한 회사에서 일하는 테크니컬 라이터들의 업무 이야기와 자신의 경험을 바탕으로 선배 테크니컬 라이터로서 도움이 될만한 이야기도 함께 제공합니다.

대상 독자

● 코드와 함께 문서를 작성해야 하는 소프트웨어 개발자
● 제품 및 서비스 전반을 파악해야 하는 프로덕트 매니저, 디벨로퍼 릴레이션 담당자
● 개발 경험이나 지식을 공유하고 싶은 기술 블로그 운영자
● 제품 및 서비스에 관한 문서를 작성하는 테크니컬 라이터
● SI 제안서를 써야하는 외주 개발자

이 책에서 다루는 내용
● 마찰 로그를 만들고 사용자 조사를 진행하여 사용자의 니즈를 파악합니다.
● README, API 문서, 튜토리얼, 개념 문서, 릴리스 노트를 포함하여 다양한 종류의 문서를 조사하고, 초안을 만들고 최종 콘텐츠를 작성합니다.
● 문서 배포 후, 사용자 피드백을 통해 콘텐츠의 품질을 유지 관리합니다.
● 프로젝트 과정을 따라가며 단계별 해야 할 업무에 대해 정리합니다.

CHAPTER 1 독자 이해하기
_Corg.ly 애플리케이션 출시 한달 전
_지식의 저주
_사용자 밑그림 그리기
_사용자 이해 검증하기
_사용자 조사 결과 압축하기
_마찰 로그 만들기
_요약

CHAPTER 2 문서화 계획하기
_Corg.ly 애플리케이션 문서화 계획 만들기
_문서화 계획과 패턴
_콘텐츠 유형
_요약

CHAPTER 3 문서 초안 만들기
_Corg.ly 애플리케이션 첫 번째 초안
_빈 페이지(화면) 대면하기
_성공적인 문서 작성을 위해 준비하기
_개요 작성하기
_초안 작성하기
_훑어보기를 고려하여 문서 작성하기
_막혔을 때 빠져나오기
_템플릿으로 작성 시작하기
_첫 번째 초안 완성하기
_요약

CHAPTER 4 문서 편집하기
_Corg.ly 애플리케이션 콘텐츠 편집하기
_사용자의 니즈에 맞춰 편집하기
_편집에 대한 여러 가지 접근법
_편집 프로세스 만들기
_피드백 받아서 반영하기
_좋은 피드백 제공하기
_요약

CHAPTER 5 샘플 코드 통합하기
_Corg.ly 애플리케이션 어떻게 작동하는지 보여주기
_샘플 코드 사용하기
_샘플 코드의 유형
_좋은 샘플 코드의 원칙
_샘플 코드 설계하기
_샘플 코드를 위한 도구
_요약

CHAPTER 6 시각적 콘텐츠 추가하기
_Corg.ly 애플리케이션 백 마디 말보다…
_말로는 부족할 때
_시각적 콘텐츠를 만들기 어려운 이유
_스크린샷 사용하기
_일반적인 다이어그램 유형
_다이어그램 그리기
_비디오 콘텐츠 만들기
_시각적 콘텐츠 검토하기
_시각적 콘텐츠 유지 관리하기
_요약

CHAPTER 7 문서 배포하기
_Corg.ly 애플리케이션 배포!
_콘텐츠 선보이기
_콘텐츠 릴리스 프로세스 구축하기
_배포 타임라인 만들기
_앞날을 위해 준비하기
_요약

CHAPTER 8 피드백 수집하고 통합하기
_Corg.ly 애플리케이션 첫 번째 피드백
_사용자 의견에 귀 기울이기
_피드백 채널 만들기
_피드백에 대해 조치 취하기
_요약

CHAPTER 9 문서 품질 측정하기
_Corg.ly 애플리케이션 출시 다음 주 화요일
_내가 쓴 문서가 괜찮은 걸까?
_문서 품질 이해하기
_분석을 위한 전략 세우기
_문서 메트릭 사용 팁
_요약

CHAPTER 10 문서 구조화하기
_Corg.ly 애플리케이션 다음 릴리스
_독자를 위해 문서 구조화하기
_독자가 길을 찾도록 돕기
_문서 구조화하기
_요약

CHAPTER 11 문서 유지 관리 및 지원 중단하기
_Corg.ly 애플리케이션 몇 번의 릴리스 후
_문서를 최신으로 유지하기
_유지 관리를 위한 계획 세우기
_문서 유지 관리 자동화하기
_콘텐츠를 문서 세트에서 제거하기
_요약

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

자레드 바티 구글 클라우드 문서 팀의 공동 설립자다. 지난 14년 동안 구글에서 다양한 프로젝트를 문서화하는 데 기여했다. 현재는 웨이모에서 기술 문서 작성 업무를 이끌고 있다.