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

책의 기본 정보

출판사

한빛미디어

출간일

2023-04-10

ISBN

9791169210881

매체

종이책

한 개발팀의 문서화 과정을 따라갑니다

가상의 서비스 개발팀이 문서를 만드는 이야기를 따라 독자 이해와 문서 계획, 초안과 편집을 배웁니다. 샘플 코드와 시각 자료를 넣고 문서를 배포한 뒤 피드백을 받아 개선하는 과정까지 이어집니다. 문장을 쓰는 기술과 제품의 일부로 문서를 운영하는 관점을 함께 다루는 구성입니다.

완성 뒤의 품질과 유지 관리까지

독자가 길을 찾도록 문서를 구조화하고 품질을 측정하는 내용이 있어 초안 작성에서 학습이 끝나지 않습니다. 예제와 템플릿을 통해 작업을 살펴보고 국내 테크니컬 라이터 인터뷰로 일을 맡는 사람들의 관점도 접할 수 있습니다. 개발자 문서를 처음 설계하거나 작성 업무를 체계화하려는 독자에게 맞습니다.

독자가 끝내야 할 과제로 점검하기

사용자가 수행할 과제를 하나 정하고 필요한 설명과 코드가 어떤 순서로 놓여야 할지 그려 보세요. 정보를 많이 싣는 일과 실제로 찾고 사용할 수 있게 만드는 일을 구분할 수 있습니다. 배포 뒤 누가 피드백을 받고 바뀐 기능을 반영할지도 적어 두면 문서의 생애를 이해하기 좋습니다.

이 책을 고르는 이유

『Docs for Developers 기술 문서 작성 완벽 가이드』는 가상의 개발팀 사례를 따라 독자 조사, 계획, 초안과 편집, 샘플 코드, 배포와 품질 측정을 설명합니다. 문서 한 장을 넘어 제품과 함께 관리할 문서 체계를 배우고 싶은 독자에게 어울립니다.

샘플 코드나 시각 자료를 넣는 이유를 독자의 과제와 연결해 보세요. 내용을 많이 싣는 것과 문제를 해결할 수 있게 돕는 것은 다를 수 있습니다. 인터뷰 부록은 이 일을 맡는 사람들의 관점을 접하는 보완 자료로 읽을 수 있습니다.

이 책과 함께 읽는 주제

• 테크니컬 라이팅 책 추천: 문서의 생애와 문장의 구조를 함께 배우기

다른 책과 비교해 보기

• 개발자가 문서 작성도 잘해야 하나요?

관련 태그

실무·기술 학습