본문 바로가기

추천 검색어

실시간 인기 검색어

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

한빛미디어

2023년 04월 10일 출간

종이책 : 2023년 04월 10일 출간

(개의 리뷰)
( 0% 의 구매자)
eBook 상품 정보
파일 정보 epub (21.80MB)
ISBN 9791169216708
듣기(TTS) 가능
TTS 란?
텍스트를 음성으로 읽어주는 기술입니다.
  • 전자책의 편집 상태에 따라 본문의 흐름과 다르게 텍스트를​ 읽을 수 있습니다.
  • 전자책 화면에 표기된 주석 등을 모두 읽어 줍니다.
  • 이미지 형태로 제작된 전자책 (예 : ZIP 파일)은 TTS 기능을 지원하지 않습니다.
  • '교보 ebook' 앱을 최신 버전으로 설치해야 이용 가능합니다. (Android v3.0.26, iOS v3.0.09,PC v1.2 버전 이상)
이벤트 소득공제
소장
정가 : 20,000원

판매가 18,000

10% 할인 | 5%P 적립

이 상품은 배송되지 않는 디지털 상품이며,
교보eBook앱이나 웹뷰어에서 바로 이용가능합니다.

카드&결제 혜택

  • 5만원 이상 구매 시 추가 2,000P
  • 3만원 이상 구매 시, 등급별 2~4% 추가 최대 416P
  • 리뷰 작성 시, e교환권 추가 최대 300원

작품소개

이 상품이 속한 분야

이 책은 ‘강아지 음성 번역 서비스’를 만드는 개발 팀의 스토리를 따라가며, 개발 문서를 만드는 과정을 단계별로 배우도록 구성되었습니다. 단계별 예제, 템플릿, 가이드를 통해 이론적인 내용뿐만 아니라 문서를 효과적으로 작성하고 관리하는 방법도 배우게 됩니다. 단계에 맞는 문서화 기술을 배우고, 사용자 니즈 이해부터 문서 작성, 유용한 개발자 문서 배포 및 유지까지 프로젝트 관리와와 소프트웨어 개발 라이프사이클 전체를 한 권에 담아 설명합니다.
또한 부록에는 우아한형제들, LINE Plus, 카카오엔터프라이즈, NHN 클라우드, 넷마블, 데브시스터즈, AWS, 쿠팡에서 활동하는 국내 유명 테크니컬 라이터 11인의 인터뷰가 수록되었습니다. 테크니컬 라이팅이 무엇인지, 업계에서 테크니컬 라이터의 역할에 대해 설명합니다. 이미 테크니컬 라이팅의 세계를 경험한 선배들의 다양한 경험과 이야기를 들을 수 있습니다.
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. 참고 자료

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

대상 독자

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

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

작가정보

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

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

저자(글) 젠 램본

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

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

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

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

이 상품의 총서

Klover리뷰 (0)

Klover리뷰 안내
Klover(Kyobo-lover)는 교보를 애용해 주시는 고객님들이 남겨주신 평점과 감상을 바탕으로, 다양한 정보를 전달하는 교보문고의 리뷰 서비스입니다.
1. 리워드 안내
구매 후 90일 이내에 평점 작성 시 e교환권 100원을 적립해 드립니다.
  • - e교환권은 적립일로부터 180일 동안 사용 가능합니다.
  • - 리워드는 1,000원 이상 eBook, 오디오북, 동영상에 한해 다운로드 완료 후 리뷰 작성 시 익일 제공됩니다.
  • - 리워드는 한 상품에 최초 1회만 제공됩니다.
  • - sam 이용권 구매 상품 / 선물받은 eBook은 리워드 대상에서 제외됩니다.
2. 운영 원칙 안내
Klover리뷰를 통한 리뷰를 작성해 주셔서 감사합니다. 자유로운 의사 표현의 공간인 만큼 타인에 대한 배려를 부탁합니다. 일부 타인의 권리를 침해하거나 불편을 끼치는 것을 방지하기 위해 아래에 해당하는 Klover 리뷰는 별도의 통보 없이 삭제될 수 있습니다.
  • 도서나 타인에 대해 근거 없이 비방을 하거나 타인의 명예를 훼손할 수 있는 리뷰
  • 도서와 무관한 내용의 리뷰
  • 인신공격이나 욕설, 비속어, 혐오 발언이 개재된 리뷰
  • 의성어나 의태어 등 내용의 의미가 없는 리뷰

구매 후 리뷰 작성 시, e교환권 100원 적립

문장수집

문장수집 안내
문장수집은 고객님들이 직접 선정한 책의 좋은 문장을 보여 주는 교보문고의 새로운 서비스 입니다. 교보eBook 앱에서 도서 열람 후 문장 하이라이트 하시면 직접 타이핑 하실 필요 없이 보다 편하게 남길 수 있습니다. 마음을 두드린 문장들을 기록하고 좋은 글귀들은 ‘좋아요’ 하여 모아보세요. 도서 문장과 무관한 내용 등록 시 별도 통보없이 삭제될 수 있습니다.
리워드 안내
  • 구매 후 90일 이내에 문장 수집 등록 시 e교환권 100원을 적립해 드립니다.
  • e교환권은 적립일로부터 180일 동안 사용 가능합니다.
  • 리워드는 1,000원 이상 eBook에 한해 다운로드 완료 후 문장수집 등록 시 제공됩니다.
  • 리워드는 한 상품에 최초 1회만 제공됩니다.
  • sam 이용권 구매 상품/오디오북·동영상 상품/주문취소/환불 시 리워드 대상에서 제외됩니다.

구매 후 문장수집 작성 시, e교환권 100원 적립

    교보eBook 첫 방문을 환영 합니다!

    신규가입 혜택 지급이 완료 되었습니다.

    바로 사용 가능한 교보e캐시 1,000원 (유효기간 7일)
    지금 바로 교보eBook의 다양한 콘텐츠를 이용해 보세요!

    교보e캐시 1,000원
    TOP
    신간 알림 안내
    Docs for Developers 기술 문서 작성 완벽 가이드 웹툰 신간 알림이 신청되었습니다.
    신간 알림 안내
    Docs for Developers 기술 문서 작성 완벽 가이드 웹툰 신간 알림이 취소되었습니다.
    리뷰작성
    • 구매 후 90일 이내 작성 시, e교환권 100원 (최초1회)
    • 리워드 제외 상품 : 마이 > 라이브러리 > Klover리뷰 > 리워드 안내 참고
    감성 태그

    가장 와 닿는 하나의 키워드를 선택해주세요.

    사진 첨부(선택) 0 / 5

    총 5MB 이하로 jpg,jpeg,png 파일만 업로드 가능합니다.

    신고/차단

    신고 사유를 선택해주세요.
    신고 내용은 이용약관 및 정책에 의해 처리됩니다.

    허위 신고일 경우, 신고자의 서비스 활동이 제한될 수
    있으니 유의하시어 신중하게 신고해주세요.


    이 글을 작성한 작성자의 모든 글은 블라인드 처리 됩니다.

    문장수집 작성

    구매 후 90일 이내 작성 시, e교환권 100원 적립

    eBook 문장수집은 웹에서 직접 타이핑 가능하나, 모바일 앱에서 도서를 열람하여 문장을 드래그하시면 직접 타이핑 하실 필요 없이 보다 편하게 남길 수 있습니다.

    P.
    Docs for Developers 기술 문서 작성 완벽 가이드
    저자 모두보기
    낭독자 모두보기
    sam 이용권 선택
    님이 보유하신 이용권입니다.
    차감하실 sam이용권을 선택하세요.
    sam 이용권 선택
    님이 보유하신 이용권입니다.
    차감하실 sam이용권을 선택하세요.
    sam 이용권 선택
    님이 보유하신 프리미엄 이용권입니다.
    선물하실 sam이용권을 선택하세요.
    결제완료
    e캐시 원 결제 계속 하시겠습니까?
    교보 e캐시 간편 결제
    sam 열람권 선물하기
    • 보유 권수 / 선물할 권수
      0권 / 1
    • 받는사람 이름
      받는사람 휴대전화
    • 구매한 이용권의 대한 잔여권수를 선물할 수 있습니다.
    • 열람권은 1인당 1권씩 선물 가능합니다.
    • 선물한 열람권이 ‘미등록’ 상태일 경우에만 ‘열람권 선물내역’화면에서 선물취소 가능합니다.
    • 선물한 열람권의 등록유효기간은 14일 입니다.
      (상대방이 기한내에 등록하지 않을 경우 소멸됩니다.)
    • 무제한 이용권일 경우 열람권 선물이 불가합니다.
    이 상품의 총서 전체보기
    네이버 책을 통해서 교보eBook 첫 구매 시
    교보e캐시 지급해 드립니다.
    교보e캐시 1,000원
    • 첫 구매 후 3일 이내 다운로드 시 익일 자동 지급
    • 한 ID당 최초 1회 지급 / sam 이용권 제외
    • 네이버 책을 통해 교보eBook 구매 이력이 없는 회원 대상
    • 교보e캐시 1,000원 지급 (유효기간 지급일로부터 7일)
    구글북액션을 통해서 교보eBook
    첫 구매 시 교보e캐시 지급해 드립니다.
    교보e캐시 1,000원
    • 첫 구매 후 3일 이내 다운로드 시 익일 자동 지급
    • 한 ID당 최초 1회 지급 / sam 이용권 제외
    • 구글북액션을 통해 교보eBook 구매 이력이 없는 회원 대상
    • 교보e캐시 1,000원 지급 (유효기간 지급일로부터 7일)