확장메뉴
주요메뉴


닫기
사이즈 비교
소득공제
Docs for Developers 기술 문서 작성 완벽 가이드

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

[ 우아한형제들 카카오 등 국내 테크니컬 라이터 11인 인터뷰 특별 수록 ]
리뷰 총점9.6 리뷰 19건 | 판매지수 8,244
베스트
IT 모바일 top20 5주
정가
25,000
판매가
22,500 (10% 할인)
분철서비스 시작 시 알려드립니다. 분철서비스 알림신청

품목정보

품목정보
발행일 2023년 04월 10일
쪽수, 무게, 크기 332쪽 | 486g | 153*223*12mm
ISBN13 9791169210881
ISBN10 1169210880

책소개 책소개 보이기/감추기

목차 목차 보이기/감추기

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

저자 소개 (6명)

출판사 리뷰 출판사 리뷰 보이기/감추기

특별 부록 : 국내 테크니컬 라이터 11인 인터뷰

「자꾸 쓰다 보면 잘 쓸 수 있습니다」
- 유영경 〈우아한 형제들〉

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

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

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

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

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

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

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

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

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

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

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

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

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

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

대상 독자

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

이 책에서 다루는 내용

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

추천평 추천평 보이기/감추기

이 책은 개발 문서를 쓰는 테크니컬 라이터, 개발자, 기획자, 모두에게 실질적인 도움을 줄 것입니다. 독자 분석부터 문서화 계획, 초안 작성, 편집, 샘플 코드와 시각 자료 다루기, 배포, 품질 측정, 유지 관리까지 문서화의 전 과정을 예시와 함께 다루고 있습니다. 저자를 따라가다 보면 어느새 개발 문서 세트를 만들어 보는 경험을 하게 됩니다. 테크니컬 라이터라면, 특히 개발 문서를 다루는 분에게는 강력하게 추천합니다.
- 이인실 (LINE Plus 테크니컬 라이터)
좋은 테크 콘텐츠를 쓰고 세상과 다양한 방식으로 소통하고 싶은 모든 분들께 이 책을 권하고 싶습니다. 이 책의 저자인 실리콘밸리의 테크니컬 라이터들이 다양한 빅테크 기업에서 일하며 얻은 노하우가 책 속에 모두 담겨 있습니다.
- 임근희 (쿠팡 테크니컬 라이터)
회사 내에서 문서화의 중요성을 설명하는 데 어려움을 겪고 있다면 이 책을 정독해볼 것을 강력하게 권합니다. 이 책은 특히 테크니컬 라이터로서 이제 막 IT 분야에 뛰어든 신입 테크니컬라이터에게 좋은 길잡이가 되어줄 것입니다.
- 남정현 (데브시스터즈 테크니컬 라이터)

회원리뷰 (17건) 회원리뷰 이동

한줄평 (2건) 한줄평 이동

총 평점 9.0점 9.0 / 10.0

배송/반품/교환 안내

배송 안내
반품/교환 안내에 대한 내용입니다.
배송 구분 예스24 배송
  •  배송비 : 무료배송
포장 안내

안전하고 정확한 포장을 위해 CCTV를 설치하여 운영하고 있습니다.

고객님께 배송되는 모든 상품을 CCTV로 녹화하고 있으며, 철저한 모니터링을 통해 작업 과정에 문제가 없도록 최선을 다 하겠습니다.

목적 : 안전한 포장 관리
촬영범위 : 박스 포장 작업

  • 포장안내1
  • 포장안내2
  • 포장안내3
  • 포장안내4
반품/교환 안내

상품 설명에 반품/교환과 관련한 안내가 있는경우 아래 내용보다 우선합니다. (업체 사정에 따라 달라질 수 있습니다)

반품/교환 안내에 대한 내용입니다.
반품/교환 방법
  •  고객만족센터(1544-3800), 중고샵(1566-4295)
  •  판매자 배송 상품은 판매자와 반품/교환이 협의된 상품에 한해 가능합니다.
반품/교환 가능기간
  •  출고 완료 후 10일 이내의 주문 상품
  •  디지털 콘텐츠인 eBook의 경우 구매 후 7일 이내의 상품
  •  중고상품의 경우 출고 완료일로부터 6일 이내의 상품 (구매확정 전 상태)
반품/교환 비용
  •  고객의 단순변심 및 착오구매일 경우 상품 반송비용은 고객 부담임
  •  직수입양서/직수입일서중 일부는 변심 또는 착오로 취소시 해외주문취소수수료 20%를 부과할수 있음

    단, 아래의 주문/취소 조건인 경우, 취소 수수료 면제

    •  오늘 00시 ~ 06시 30분 주문을 오늘 오전 06시 30분 이전에 취소
    •  오늘 06시 30분 이후 주문을 익일 오전 06시 30분 이전에 취소
  •  직수입 음반/영상물/기프트 중 일부는 변심 또는 착오로 취소 시 해외주문취소수수료 30%를 부과할 수 있음

    단, 당일 00시~13시 사이의 주문은 취소 수수료 면제

  •  박스 포장은 택배 배송이 가능한 규격과 무게를 준수하며, 고객의 단순변심 및 착오구매일 경우 상품의 반송비용은 박스 당 부과됩니다.
반품/교환 불가사유
  •  소비자의 책임 있는 사유로 상품 등이 손실 또는 훼손된 경우
  •  소비자의 사용, 포장 개봉에 의해 상품 등의 가치가 현저히 감소한 경우 : 예) 화장품, 식품, 가전제품, 전자책 단말기 등
  •  복제가 가능한 상품 등의 포장을 훼손한 경우 : 예) CD/LP, DVD/Blu-ray, 소프트웨어, 만화책, 잡지, 영상 화보집
  •  소비자의 요청에 따라 개별적으로 주문 제작되는 상품의 경우
  •  디지털 컨텐츠인 eBook, 오디오북 등을 1회 이상 다운로드를 받았을 경우
  •  eBook 대여 상품은 대여 기간이 종료 되거나, 2회 이상 대여 했을 경우 취소 불가
  •  중고상품이 구매확정(자동 구매확정은 출고완료일로부터 7일)된 경우
  •  LP상품의 재생 불량 원인이 기기의 사양 및 문제인 경우 (All-in-One 일체형 일부 보급형 오디오 모델 사용 등)
  •  시간의 경과에 의해 재판매가 곤란한 정도로 가치가 현저히 감소한 경우
  •  전자상거래 등에서의 소비자보호에 관한 법률이 정하는 소비자 청약철회 제한 내용에 해당되는 경우
소비자 피해보상
  •  상품의 불량에 의한 반품, 교환, A/S, 환불, 품질보증 및 피해보상 등에 관한 사항은 소비자분쟁해결기준(공정거래위원회 고시)에 준하여 처리됨
환불 지연에
따른 배상
  •  대금 환불 및 환불 지연에 따른 배상금 지급 조건, 절차 등은 전자상거래 등에서의 소비자 보호에 관한 법률에 따라 처리
  •  쿠폰은 결제 시 적용해 주세요.
1   22,500
뒤로 앞으로 맨위로 공유하기