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

자레드바티,재커리사라콜라이센,젠램본,데이비드누네즈,하이디워터하우스

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

저자:재커리사라콜라이센
리눅스재단수석테크니컬라이터였고,책을마무리할시점에는스트라이프의수석스태프테크니컬라이터가되었다.2017년부터2021년까지쿠버네티스문서화프로젝트공동의장을역임했으며,그전까지는깃헙,랙스페이스및여러스타트업에서개발자문서를만들었다.

저자:젠램본
몬조뱅크에서테크니컬라이팅및지식관리부서를이끌고있다.핀테크분야에진출하기전에는GDS의테크니컬라이팅책임자로서영국정부전체의문서관리자커뮤니티를이끌었다.

저자:데이비드누네즈
스트라이프에서테크니컬라이팅조직을이끌고있으며,내부문서화팀을설립하고『인크리먼트』잡지에글을기고하기도했다.우버에서테크니컬라이팅조직을설립하고이끌었으며,세일즈포스에서문서화리더역할을맡았다.

저자:하이디워터하우스
수십년동안마이크로소프트,델소프트웨어및수많은스타트업에서개발자와소통하고개발자를위해소통하는방법을배웠다.현재론치다클리에서수석디벨로퍼릴레이션담당자로일하고있다.

역자:하성창
컴퓨터기술을다루는글쓰기와번역일을하고있다.주로테크니컬라이터로일했고,소프트웨어개발자와로컬라이제이션(제품현지화)담당자로일하기도했다.시간이날때는집에서음악듣기를즐긴다.『유닉스의탄생』과『1일1로그100일완성IT지식』을번역했다.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

대상독자

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

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