개발자는 글을 못 쓴다고요? (반양장)

전정은

LINEPLUS에서기술문서를효율적으로작성하고관리하는방법을추구하는문서엔지니어다.회사에서는기술문서를쓰는한편으로더나은글쓰기도구를만들고있으며,회사밖에서는블로그와강연을통해글쓰기경험을공유하고있다.고전적인방식에머무르기보다새로운기술을접목해문서의품질과가치를높이는일에즐거움을느낀다.AI가글쓰기를대체할것이라는우려속에서도‘변화에적응하며기회를찾으면된다’고믿는낙관론자이기도하다.소설가를꿈꾸던감수성과컴퓨터에빠져공학을배운논리력을발휘해,재미있고논리적인글쓰기의세계를탐험하고있다.

추천의글12
베타리더후기18
여는글20

PARTI개발자는정말글을못쓸까?
1개발자는코드로소통한다?27
2반복,또반복29
3글에는목적이있다31
4번역서참고는그만34

PARTII글을잘쓰는개발자는코드부터다르다
5커밋메시지작성하기41
커밋메시지를잘써야하는이유43
커밋을설계하세요46
[쉬어가기]커밋메시지해부학47
커밋메시지제목쓰기49
커밋메시지본문쓰기64
커밋메시지작성해보기68
커밋메시지맛집70

6개발자는작명가72
함수에걸맞은이름짓기74
함수이름짓기연습84

7오류메시지쓰기100
오류메시지구성요소101
오류메시지를봤는데무슨말인지모르겠다103
어떻게해결해야하는지모르겠다107
오류메시지에있는안내대로했는데해결이안된다109
해결방법을어디서찾아야하는지모르겠다109
[쉬어가기]금과은나없어도내게있는것네게주니110

8API주석111
API주석형식116
API설명기본규칙118
실전연습124
설명문형식정하기128
[쉬어가기]API설명은영어여야만할까요?130
OpenAPI명세로쓰기131
도구를너무믿지말자133
[쉬어가기]미래의나를위해서라도꼭쓰세요!134

PARTIII개발자의글은곧PR이다
9리드미139
나를읽어주세요142
리드미에써야할정보는?143
실전리드미작성148
[쉬어가기]‘모두가아는정보’판단법153
이왕이면다홍치마154
템플릿,널위해준비했어157

10예시코드159
예시코드가있어야할곳160
소스코드말고예시를161
소스코드를예시로만드는주문168
[쉬어가기]예시코드에서내부정보감추기172
샘플프로그램173
[쉬어가기]cURL예시도RESTAPI예시코드일까요?175
작동하지않으면코드가아니다177

11장애보고서179
[쉬어가기]서비스가멈추는순간,우리가겪는불편함181
장애보고서란?181
장애보고서엔무엇을쓰나요?183
장애보고서는누가쓰나요?192
장애보고서는언제쓰나요?193
장애보고서는어디에쓰나요?195

12릴리스노트206
릴리스노트?체인지로그?207
[쉬어가기]반박시당신말씀이맞습니다만,저도맞을수있지않을까요?210
릴리스노트를알아봅시다211
[쉬어가기]끝날때까진끝난것이아니다!deprecated는‘아직’이에요213
[쉬어가기]릴리스노트가길어지면어쩌죠?221
[쉬어가기]문서도릴리스노트를써야할까요?228
체인지로그를알아봅시다229
[쉬어가기]해당하는정보가없을땐없다고명시하세요234

13시작하기문서236
시작하기의도입부:가입과설치238
시작하기의핵심:기본기능수행240
시작하기의마무리243
문제점찾기연습246

14기술블로그253
무엇을얻고싶은가요?254
블로그,기본틀257
블로그,어떤글을쓸까요?268
[쉬어가기]글로영업해보세요270
블로그,쓸때생각해볼것276
[쉬어가기]소화할수있는글쓰기277
블로그,시작해봅시다283
블로그,어렵죠?289

PARTIV기술글쓰기에는기법이있다
15정확성295
정확한용어사용하기298
[쉬어가기]실무에서쓰는표현기술문서에알맞게포장하기305
명령문과평서문307
명령문과평서문둘다표현할수있을때는?316
[쉬어가기]쉴수있을때쉬어야하니쉬세요!317
최신정보반영하기317

16간결성326
두괄식으로쓰기328
목록과표335
[쉬어가기]점목록만으로쓴문서는정말읽기쉬울까요?341
[쉬어가기]귀찮지만포기할수없는셀병합345
다이어그램348

17완결성363
도입부쓰기364
[쉬어가기]용어설명은짧은팝업으로출력해보세요371
[쉬어가기]형식과기법보다는내용과목적이중요합니다374
일단쓰고지우기374
우리말로글쓰기387
[쉬어가기]지금무슨말을하고있는지아나요?389
[쉬어가기]우리말,우리글로도할수있어요396

APPENDIX메시지도,AI도구도글쓰기에서시작된다
A이메일이나메시지쓰기403
이메일또는남겨둘메시지쓰기404
지시하고응답하기406
문제상황보고하기408

BChatGPT활용하기411
‘네가해줘’말고‘도와줘’411
API주석쓰기413
규칙검사하기419

도판출처426

코드만큼중요한문서,이제는쓰는법도알려드립니다
“개발자는글을못쓴다?”

개발자들이정말글을못쓴다면그수많은기술문서와블로그글은누가쓴걸까요?모두개발자가쓴글입니다.매일커밋메시지를쓰고,변수명을짓고,리드미를작성하고,슬랙에답하며끊임없이글을씁니다.그럼에도많은개발자가글쓰기를어려워합니다.‘무엇을’,‘어떻게’써야할지배운적이없기때문입니다.

이책은그막막함에실전적인답을줍니다.커밋메시지를한줄로깔끔하게쓰는법,변수명과함수명을더명확하게짓는원칙,오류메시지와주석을사용자입장에서다듬는방법,리드미와시작하기문서를쉽게구성하는법,기술블로그로설명력을높이는팁까지실무에바로쓸수있는글쓰기전략을실제사례와함께설명합니다.여기에이메일과슬랙메시지처럼협업에꼭필요한글쓰기부터ChatGPT에게제대로묻고설명하는프롬프트작성까지지금의개발자에게꼭필요한기술적글쓰기를폭넓고깊이있게다룹니다.

개발자는글을못쓴다?아니요.이책과함께라면개발자도글을잘쓸수있습니다.

·주요내용
●커밋메시지,오류메시지,주석을명확하게쓰는법
●변수명과함수명을잘짓기위한작명원칙
●리드미,릴리스노트,시작하기문서의실전구성법
●기술블로그와예제코드로설명력을높이는방법
●정확하고간결한기술문서를쓰는세가지기법
●이메일,메시지잘쓰는법과ChatGPT활용팁