본문내용 바로가기
무료배송 소득공제

[출간예정] 개발자를 위한 글쓰기 가이드 예제로 배우는 테크니컬 라이팅 핵심 비법

유영경 지음 | 로드북 | 2021년 02월 26일 출간
  • 정가 : 16,000원
    판매가 : 14,400 [10%↓ 1,600원 할인]
  • 통합포인트 :
    [기본적립] 800원 적립 [5% 적립] [추가적립] 5만원 이상 구매 시 2천원 추가적립 안내 [회원혜택] 실버등급 이상, 3만원 이상 구매 시 2~4% 추가적립 안내
  • 추가혜택 : 포인트 안내 도서소득공제 안내 추가혜택 더보기
  • 배송비 : 무료 배송비 안내
  • 예약판매 : 2021년 2월 27일 출고 예정 배송일정 안내

알립니다.

  • 본 도서는 2021년 2월 27일 출고 예정인 출간예정도서 입니다. 단, 출판사의 사정으로 출간이 지연될 수 있으니, 이점 양해 부탁드립니다.
  • 본 도서는 출판사의 사정으로 출간이 지연될 수 있으며,
    본 도서와 같이 구매하신 상품은 본 도서의 출간과 더불어 출고되오니 이점 유의하시기 바랍니다.
  • 출간예정 도서의 경우 실제 출간 후 도서정보가 달라질 수 있습니다. 이 점 양해 부탁드립니다.
장바구니 담기 바로구매 선물하기 보관함 담기 출간알림신청
상품상세정보
ISBN 9788997924806(899792480X)
쪽수 288쪽
크기 152 * 210 mm 판형알림

책소개

이 책이 속한 분야

Microsoft, NAVER, NHN에서 20년
베테랑 테크니컬 라이터의 글쓰기 비법

개발자가 코딩만 잘하면 된다? 고객의 요구사항 분석을 제대로 글로 옮기지 못한다면 무슨 일이 발생할까? 장애 발생 시 공지문을 작성해야 하는데, 빠짐없이 정확하게 작성할 수 있을까? 오류와 확인 메시지는 제대로 쓸 수 있을까? UI에 들어가는 텍스트는? 소프트웨어 제품 출시 후 사용자 가이드는 어떻게 만들어야 할까? 개발자는 코딩 영역 외에도 이렇게 수많은 글쓰기 문제에 직면한다. 이를 위해 저자는 테크니컬 라이터로서 20년 이상 개발자와 함께하며 얻는 핵심 노하우를 이 책 한 권에 정리하였다. 옆에 두고 항상 참고할 수 있는 개발자만을 위한 글쓰기 가이드이다.

샘플원고 ☞ https://roadbook.co.kr/246

-----------대상 독자: 이런 고민을 하는 독자-----------
고객의 요구사항을 정리하는 데 어려움을 겪는 개발자
협업 미팅을 해야 할 때 나의 보고서가 부끄러운 개발자
장애 보고서는 어떻게 써야 할지 난감한 개발자
회의록을 기록하며 업무를 해야 하는 개발자
버튼 텍스트, 오류 메시지 작성 등에 고민이 많은 개발자
남들이 나의 글을 제대로 이해하지 못한다고 생각하는 개발자
전문 테크니컬 라이터가 없는 중소규모의 소프트웨어 기업

상세이미지

개발자를 위한 글쓰기 가이드 도서 상세이미지

목차

저자의 말

1부 테크니컬 라이팅 시작하기

1장 테크니컬 라이팅
테크니컬 라이팅과 기술 문서
테크니컬 라이팅과 일반 글쓰기의 차이
테크니컬 라이팅 5단계

2장 개발자와 테크니컬 라이팅
개발자와 테크니컬 라이팅
그냥 쓰는 것이 아니라 제대로 쓰기

2부 테크니컬 라이팅 45가지 원칙

3장 문서 작성 계획 세우기
01 대상 독자를 정한다
02 설명할 기술의 깊이를 조절한다
03 분위기를 좌우할 어조를 정한다
04 주제를 구체적으로 정한다
05 작성할 문서의 종류를 정한다

4장 초안 작성
06 일단 쓴다
07 명확성, 간결성, 일관성의 3원칙
08 핵심부터 쓴다
09 제목에 요점을 담는다
10 문장 하나에는 주제를 하나만 쓴다
11 객관적인 근거를 댄다
12 전문 용어는 독자에 맞게 사용한다
13 용어와 약어를 쓸 때는 풀이를 쓴다
14 용어는 일관되게 사용한다
15 쉽게 쓴다

5장 시각화 요소로 가독성 높이기
16 적합한 시각 자료를 활용한다
17 목록을 사용해 정리한다
18 스크린숏으로 이해도를 높인다
19 정보를 비교할 때는 표를 활용한다
20 데이터 성격에 맞는 차트를 사용한다
21 시각 자료를 쓰기 전에 소개부터 한다
22 시각 자료를 설명하는 캡션을 활용한다

6장 검토와 재작성
23 객관적으로 문서를 검토한다
24 맥락에 맞는 적확한 단어를 선택한다
25 은어는 형식적인 표현으로 바꾼다
26 대명사는 일반 명사로 바꾼다
27 고유한 이름은 정확히 쓴다
28 숫자와 단위를 정확하게 쓴다
29 단정적인 어조로 확신 있게 쓴다
30 글꼬리를 뚜렷하게 쓴다
31 주어와 서술어를 일치시킨다
32 문장은 짧게 줄인다
33 군더더기 표현을 없앤다
34 의미가 같은 표현은 한 번만 쓴다
35 피동태보다 능동태로 쓴다
36 복잡한 번역체를 다듬는다
37 ‘통해’는 명확한 표현으로 바꾼다
38 ‘무엇은 ~ 무엇이다’ 형식으로 쓰지 않는다
39 ‘~해 주다’ 대신 ‘~하다’를 쓴다
40 조사를 덜어낸다
41 재작성한 문서를 동료와 검토한다
42 자주 틀리는 맞춤법
43 자주 틀리는 외래어 표기법
44 자주 틀리는 띄어쓰기
45 자주 틀리는 문장 부호

3부 유형별 테크니컬 라이팅 사례로 본 작성의 원칙
-메일ㆍ회의록ㆍ장애 발생 공지문ㆍ사용자 가이드

7장 메일 작성
46 받는 사람이 궁금해할 내용을 쓴다
47 인사말과 맺음말은 과하지도 부족하지도 않게 쓴다
48 받는 사람을 명확하게 지정한다
49 첨부 파일을 확인한다

8장 회의록 작성
50 회의록 구성 요소를 확인한다
51 회의록 작성 원칙을 기억한다

9장 오류와 확인 메시지 작성
52 확인 메시지 작성법
53 오류 메시지에서 중요한 것은 해결 방법
54 메시지에서도 제목을 활용한다
55 직관적인 버튼 텍스트를 만든다

10장 장애 발생 공지문 작성 1부
56 장애 발생 공지문의 기본 요소: 장애 발생 직후
57 장애 해결 공지문의 기본 요소: 장애 해결 후
58 장애 보고서 작성: 내부 보고와 기록용

11장 사용자 가이드 작성
59 사용자에게 맞는 가이드 종류를 선택한다
60 개념과 목적을 설명하는 개요를 추가한다
61 사용법은 순차적으로 설명한다
62 퀵스타트 가이드로 제품과 빠르게 친숙해지게 한다

참고 자료

출판사 서평

“테크니컬 라이팅:
기술이나 과학 분야에서 정보를 정학하게 전달하기 위한 글쓰기”

“개발자 나길동 씨는 아침에 출근해 오늘 할 일을 메모하는 글쓰기로 하루를 시작합니다. 서비스 출시 회의 내용을 정리하는 것도, 관련 부서에 회의 결과와 남은 버그를 공유하는 메일을 쓰는 것도 글쓰기입니다. 다음 주부터 출근하는 신입사원이 봐야 할 코딩 컨벤션도 작성해야 합니다. 출시한 서비스의 버그로 보고된 오류 메시지도 추가로 써야 합니다.
회사 기술 블로그에 JavaScript 성능을 최적화한 경험과 사례를 공유하는 글을 쓰기 시작할 ... 더보기

Klover 리뷰 (0)

북로그 리뷰 (0) 쓰러가기

도서 구매 후 리뷰를 작성하시면
결제 90일 이내 300원, 발송 후 5일 이내 400원, 이 상품의 첫 리뷰 500원의 포인트를 드립니다.

포인트는 작성 후 다음 날 적립되며, 도서 발송 전 작성 시에는 발송 후 익일에 적립됩니다.
북로그 리뷰는 본인인증을 거친 회원만 작성 가능합니다.
(※ 외서/eBook/음반/DVD/GIFT 및 잡지 상품 제외) 안내
  • 해당도서의 리뷰가 없습니다.

문장수집 (0) 문장수집 쓰기 나의 독서기록 보기
※구매도서의 문장수집을 기록하면 통합포인트 적립 안내

교환/반품/품절안내

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

교환/반품/품절안내
반품/교환방법 마이룸 > 주문관리 > 주문/배송내역 > 주문조회 > 반품/교환신청 ,
[1:1상담>반품/교환/환불] 또는 고객센터 (1544-1900)

※ 오픈마켓, 해외배송주문, 기프트 주문시 [1:1상담>반품/교환/환불]
    또는 고객센터 (1544-1900)
반품/교환가능 기간 변심반품의 경우 수령 후 7일 이내,
상품의 결함 및 계약내용과 다를 경우 문제점 발견 후 30일 이내
반품/교환비용 변심 혹은 구매착오로 인한 반품/교환은 반송료 고객 부담
반품/교환 불가 사유
  • 소비자의 책임 있는 사유로 상품 등이 손실 또는 훼손된 경우
    (단지 확인을 위한 포장 훼손은 제외)
  • 소비자의 사용, 포장 개봉에 의해 상품 등의 가치가 현저히 감소한 경우
    예) 화장품, 식품, 가전제품(악세서리 포함) 등
  • 복제가 가능한 상품 등의 포장을 훼손한 경우
    예) 음반/DVD/비디오, 소프트웨어, 만화책, 잡지, 영상 화보집
  • 소비자의 요청에 따라 개별적으로 주문 제작되는 상품의 경우 ((1)해외주문도서)
  • 디지털 컨텐츠인 eBook, 오디오북 등을 1회 이상 다운로드를 받았을 경우
  • 시간의 경과에 의해 재판매가 곤란한 정도로 가치가 현저히 감소한 경우
  • 전자상거래 등에서의 소비자보호에 관한 법률이 정하는 소비자 청약철회 제한 내용에
    해당되는 경우
(1) 해외주문도서 : 이용자의 요청에 의한 개인주문상품으로 단순변심 및 착오로 인한 취소/교환/반품 시 ‘해외주문 반품/취소 수수료’ 고객 부담 (해외주문 반품/취소 수수료 : ①서양도서-판매정가의 12%, ②일본도서-판매정가의 7%를 적용)
상품 품절 공급사(출판사) 재고 사정에 의해 품절/지연될 수 있으며, 품절 시 관련 사항에 대해서는
이메일과 문자로 안내드리겠습니다.
소비자 피해보상
환불지연에 따른 배상
  • 상품의 불량에 의한 교환, A/S, 환불, 품질보증 및 피해보상 등에 관한 사항은
    소비자분쟁해결 기준 (공정거래위원회 고시)에 준하여 처리됨
  • 대금 환불 및 환불지연에 따른 배상금 지급 조건, 절차 등은 전자상거래 등에서의
    소비자 보호에 관한 법률에 따라 처리함

바로가기

  • 우측 확장형 배너 2
  • 우측 확장형 배너 2

최근 본 상품