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

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

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

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

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

유영경

Microsoft에서운좋게테크니컬라이터라는직무를알게된후20년이상이를업으로삼고있다.NAVER기술문서팀팀장을거쳐현재는NHN에서테크니컬라이팅,UX라이팅,IT콘퍼런스기획총괄,글쓰기교육등을전담하고있다.『웹기획자가알아야할서비스글쓰기의모든것』(2013,위키북스)을공동집필했다.

목차

저자의말

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성능을최적화한경험과사례를공유하는글을쓰기시작할때면머리가아파져옵니다.한줄쓰고지우고,한줄쓰고지우고.몇시간째한페이지를넘기지못합니다.바람이나쐐야지.덮어두고다른일을시작하지만,마음한켠이점점더무거워집니다.”

[이책이제시하는개발자나길동씨를위한고민해결책]

_쉽게실천할수있는테크니컬라이팅기본규칙
이책에서소개하는기본규칙만잘이해하고실천한다면개발자나길동씨도누구나이해하기쉽고빠른글쓰기를할수있습니다.

_수많은사례의예시문을통한반복연습
규칙을이해했다면이제는다양한사례의예시문을반복해서고쳐보며연습해야합니다.연습없이결코글을잘쓸수없습니다.

_오랫동안개발자와함께한테크니컬라이터의핵심비법
저자는오랫동안개발자와함께해왔습니다.글쓰기교육,소프트웨어관련테크니컬라이팅업무를하며익힌핵심비법의정수를담았습니다.

이책을통해클린코드못지않은클린테크니컬라이팅능력도갖추길바랍니다.

_편집자코멘트
개발자는고객의요구사항을정확하게정리해내고,협업과정에서문제없이의사소통을할수있어야하며,사용자가코딩의결과물을불편없이사용하게해주어야한다.이것은코딩외적인능력에속하며,이를위해가장기본적으로필요한소양이바로기술적글쓰기,테크니컬라이팅능력이다.
대기업에속한개발자들은전문테크니컬라이터에게필요한지원을받을수있지만,수많은개발자들은스스로해결해야하는경우가많다.이책은회사의지원을받지못하는개발자들을위해가장기본이되는기술적글쓰기의규칙과사례를정리하여언제나참고할수있는가이드이다.
바쁜개발자들을위해넘치거나부족하지않은책이나온것같아편집자로서정말기쁘다.기술서적을기획,출간하고있는편집자도이책을항상옆에끼고참고하려고한다.