소프트웨어 개발자를 안내하는 테크니컬 라이팅을 위한 실무 노트



우아한형제들, 카카오, AWS, LINE Plus, 쿠팡, NHN, 데브시스터즈, 넷마블 등 국내 테크니컬 라이터 11인 인터뷰 특별 수록!



이 책은 ‘강아지 음성 번역 서비스’를 만드는 개발 팀의 스토리를 따라가며, 개발 문서를 만드는 과정을 단계별로 배우도록 구성되었습니다. 단계별 예제, 템플릿, 가이드를 통해 이론적인 내용뿐만 아니라 문서를 효과적으로 작성하고 관리하는 방법도 배우게 됩니다. 단계에 맞는 문서화 기술을 배우고, 사용자 니즈 이해부터 문서 작성, 유용한 개발자 문서 배포 및 유지까지 프로젝트 관리와와 소프트웨어 개발 라이프사이클 전체를 한 권에 담아 설명합니다.

또한 부록에는 우아한형제들, LINE Plus, 카카오엔터프라이즈, NHN 클라우드, 넷마블, 데브시스터즈, AWS, 쿠팡에서 활동하는 국내 유명 테크니컬 라이터 11인의 인터뷰가 수록되었습니다. 테크니컬 라이팅이 무엇인지, 업계에서 테크니컬 라이터의 역할에 대해 설명합니다. 이미 테크니컬 라이팅의 세계를 경험한 선배들의 다양한 경험과 이야기를 들을 수 있습니다.

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

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. 참고 자료