특별 부록 : 국내 테크니컬 라이터 11인 인터뷰
「자꾸 쓰다 보면 잘 쓸 수 있습니다」
- 유영경 〈우아한 형제들〉
「기술 문서를 책임지는 사람들, 테크니컬 라이터」
- 김유리 〈카카오엔터프라이즈〉
「AWS 머신러닝 테크니컬 라이터가 된 천체물리학 박사의 이야기」
- 최미영 〈AWS〉
「2세대 테크니컬 라이터의 이야기」
- 전정은 〈LINE Plus〉
「테크니컬 라이터가 가져야 하는 자세」
- 임근희 〈쿠팡〉
「직업으로서의 테크니컬 라이터」
- 박선영 〈NHN 클라우드〉
「LINE에서 테크니컬 라이터가 하는 일」
- 이인실 〈LINE Plus〉
「테크니컬 라이터의 자세」
- 남정현 〈데브시스터즈〉
「IT 기업 테크니컬 라이터의 경험과 짧은 소회」
- 강정일 〈LINE Plus〉
「테크니컬 라이터의 이야기」
- 이중민 〈넷마블〉
「테크니컬 라이터도 그냥 흔한 동료 중 한 명입니다」
- 조병승 〈넷마블〉
개발 생태계 모든 사람을 위한
이야기로 배우는 기술 문서 작성법
좋은 문서화와 프로그래밍을 통합하는 것은 중요합니다. 문서화가 잘된 프로젝트는 개발자와 사용자 모두에게 도움을 줍니다. 적절한 기술 문서가 없는 프로젝트에서는 개발자 생산성, 프로젝트 확장성, 사용자의 제품 채택률과 접근성이 저하될 뿐만 아니라 프로젝트 성공 확률까지 낮아집니다. 그만큼 프로젝트 진행에 있어 좋은 문서화는 필수 조건입니다.
이 책은 가상의 소프트웨어 개발 팀이 새 제품을 출시하는 과정에 따라 개발자 문서를 만드는 과정을 설명합니다. 사용자의 니즈를 조사하고, 일반적인 문서화 패턴에 따라 계획 수립부터 콘텐츠 초안 작성과 편집 후 배포하는 과정까지 알려줍니다. 배포 후에도 피드백을 취합하고, 문서의 유효성을 측정하는 등 문서의 규모가 커짐에 따라 유지 관리하는 데 필요한 실용적인 조언을 함께 제공합니다.
또한 원서에는 담기지 않았던 국내 유명 테크니컬 라이터 11인의 인터뷰를 수록하여, 다양한 회사에서 일하는 테크니컬 라이터들의 업무 이야기와 자신의 경험을 바탕으로 선배 테크니컬 라이터로서 도움이 될만한 이야기도 함께 제공합니다.
대상 독자
● 코드와 함께 문서를 작성해야 하는 소프트웨어 개발자
● 제품 및 서비스 전반을 파악해야 하는 프로덕트 매니저, 디벨로퍼 릴레이션 담당자
● 개발 경험이나 지식을 공유하고 싶은 기술 블로그 운영자
● 제품 및 서비스에 관한 문서를 작성하는 테크니컬 라이터
● SI 제안서를 써야하는 외주 개발자
이 책에서 다루는 내용
● 마찰 로그를 만들고 사용자 조사를 진행하여 사용자의 니즈를 파악합니다.
● README, API 문서, 튜토리얼, 개념 문서, 릴리스 노트를 포함하여 다양한 종류의 문서를 조사하고, 초안을 만들고 최종 콘텐츠를 작성합니다.
● 문서 배포 후, 사용자 피드백을 통해 콘텐츠의 품질을 유지 관리합니다.
● 프로젝트 과정을 따라가며 단계별 해야 할 업무에 대해 정리합니다.
