개발자의 글쓰기 - 변수 네이밍부터 릴리스 노트, 장애 보고서, 기술 블로그까지, 프로그래머의 글쓰기 고민 끝!

김철수

저자:김철수
한양대국문과를졸업하고개발자,기획자,컨설턴트,강사등으로불리며벤처에서대기업까지다양한회사와직종에서20년을일했다.
코오롱그룹IT계열사코오롱베니트㈜에서공공SI프로젝트PM도하고에너지관리솔루션도개발하고코오롱그룹의"Industry4.0동향보고서"편집장도했다.그전에는벤처기업㈜프리챌에서아이템사업부장으로일했고,텍스트분석솔루션을개발하는스타트업등에서서비스를기획하고개발했다.그때첫책으로웹2.0과서비스기획을다룬『싸이월드는과연다음을넘어섰을까?』를출간했다.
지금은모바일퀴즈애플리케이션과콘텐츠큐레이션서비스를개발해운영하면서AI기반실내환기알고리즘을연구하고있다.개발중에틈틈이글을써서인공지능시대에생각의생산성을높이는방법을다룬『생각경영법』과『팀장을위한보고서검토기술』같은책도썼다.비즈니스글쓰기,테크니컬라이팅,디지털역량,신사업기획을주제로강의와컨설팅을하고서울창의혁신투어프로그램도만들어진행한다.

▣[프롤로그]개발자의글쓰기는달라야한다
개발자는글을못쓴다?
개발자글쓰기의특징:정확성,간결성,가독성
개발자의글쓰기

▣1장:개발자가알아야할글쓰기기본
01문장과단락을구조화하는법
___문장을구조화하는법
___서술식,개조식,도식의차이
___개조식서술방식과글머리기호
___단락을구조화하는위계
02쉽게쓰는띄어쓰기와문장부호
___가장쉬운띄어쓰기원칙
___오해하기쉬운문장부호(큰따옴표,작은따옴표)
03영어단어선택과외래어표기법
___비슷한듯다른듯,단어선택
___외산제품표기와외래어표기법

▣2장:개발시간을줄여주는이름짓기와주석쓰기
01네이밍컨벤션,이유를알고쓰자
___개발자의가장큰고민은이름짓기
___이름짓기는창조가아니라조합
___코드의네이밍컨벤션은영어표기법을상속받았다
___파스칼표기법으로클래스이름짓기
___카멜표기법으로함수·변수의이름짓기
___상수는모두대문자로쓴다
___패키지와모듈은모두소문자로쓴다
___BEM표기법
___가독성과소통이먼저다
02변수이름을잘짓는법
___i는변수이름이지만d는아니다
___긴이름?짧은이름?검색잘되는이름!
___복수형을나타내는s를붙일까말까?
___약어를쓰는것이좋을까?안쓰는것이좋을까?
___중요한단어를앞에쓴다
___함수이름짓는순서
03좋은이름의기준,SMART
___한번에좋은이름을지을수는없다
___좋은이름이가진5가지특징
___easytoSearch:검색하기쉽게이름짓는법
___easytoMix:조합하기쉽게이름짓는법
___easytoAgree:수긍하기쉽게이름짓는법
___easytoRemember:기억하기쉽게이름짓는법
___easytoType:입력하기쉽게이름짓는법
04좋은코드에는주석이없다?
___이름을잘지으면주석을줄일수있다
___처음부터주석없이코딩하는연습을하자
___주석이필요한때도많다
05다른개발자를배려하는주석쓰기
___코드는의미를,주석은의도를
___주석의반복
___주석의발췌와요약
___주석도코드다

▣3장:사용자와소통하는에러메시지쓰기
01에러메시지를쓰기전에에러부터없애자
___친절한404,불친절한404
___404에러가죄송할일인가?
___깨진링크는개발자의책임이다
___개발자용에러메시지와사용자용에러메시지를분리하자
02사용자에러메시지를제대로쓰는법
___사용자에러에대처하는메시지
___에러메시지를보여주는순서
___오락가락메시지와버튼메시지
03사용자의에러를줄이는메시지구조화
___버튼의순서
___사용자의반복에러를막는법
04에러메시지대신예방메시지를쓰자
___서비스를이해하면에러를예방할수있다
___사용자를이해하면에러를예방할수있다.
___닭이먼저?알이먼저?

▣4장:독자관점에서릴리스문서와장애보고서쓰기
01체인지로그를분류,요약,종합하는법
___체인지로그의양과만족도의관계
___1단계:선정하기
___2단계:분류하기
___3단계:요약하기
___4단계:종합하기
02고객에게유용한정보를쓰자
___개발자관점과고객관점
___과거를리뷰하고미래를보여주자
___SemanticVersioning(유의적버전)
03릴리스문서는문제해결보고서처럼쓰자
___문제와문제점을구별하자
___문제,문제점,해결책,후속계획순으로적자
___법적인문제를고려해서쓰자
04비즈니스를이해하는장애보고서쓰기
___장애보고서의특징
___질문에대답하는신속한글쓰기
___원인과이유를찾는분석적글쓰기
___상사를고려하는비즈니스관점의글쓰기
___원하는것을얻는정치적글쓰기

▣5장:설명,묘사,논증,서사로개발가이드쓰기
01서비스개념을범주,용도,특징으로설명하자
___범주,용도,특징
___범주를정확하고적절하게선택하자
___용도를범주의핵심기능으로기술하자
___특징을장점과강점에서뽑아쓰자
02정확히이해하도록그림과글로묘사하자
___글에묘사를더하면이해가빠르다
___글과그림의내용을일치시키자
___객관적묘사와주관적묘사둘다하자
03논증으로유용한정보를제공하자
___의견을쓰려면근거를대자
___거칠게도공손하게도쓰지말자
___주장과이유의거리를좁혀서쓰자
___문제와답의거리를좁혀서쓰자
04서사를활용해목차를만들자
___개발과서사
___독자의수준대신기술의범용성을기준으로쓰자
___순서에서단계를,단계에서목차를만들자

▣6장:수주를돕는SI제안서쓰기
01개발자가알아야할제안서작성원칙
___개발자와제안PM의차이
___시스템구성도의본질은그림이아니다
___첫째,제안요청서분석
___둘째,논리적완결성
02고객의문제인식과제안사의문제해결능력
___문제인식과문제해결능력
______①경쟁사와비교하여제안하라
______②일단동감하고다른방안을제시하라
______③고객이문제를중대하게인식하게만들어라
______④경쟁사의전략을확인해서대처하라
03고객의요구사항은변할수밖에없다
___개발은고객요구실현
___요구사항을분석하지말고제시하라
___변화하는요구사항에대비하라
04고객의총만족도를높이자
___요구라고다같은요구가아니다
___카노모델로본요구의세가지종류

▣7장:기술블로그쉽게쓰고운영하기
01기술블로그를쉽게쓰는방법3가지
___개발자가기술블로그를잘못쓰는이유
______첫째,주제의식을버리고소재의식으로쓰자
______둘째,독자수준이아니라자기수준으로쓰자
______셋째,재미있게글을쓰자
02글의종류별로목차잡는법I-저술
___기술블로그의4종류,저,술,편,집
______저:개발기는목차를잘잡아서본문부터쓰자
______술:원전을비교하고실험해풀이해서쓰자
03글의종류별로목차잡는법II-편집
______편:순서를요약하여쓰자
______집:글쓰기가두렵다면자료를모아핵심을엮어서쓰자
04기업의기술블로그운영팁
___기술블로그는회사의가치를높인다
___기술블로그도투자를해야살아난다
___개발자의글쓰기는회사의문화를반영한다
___협업해서글쓰기,짝글쓰기를해보자

▣[애필로그]회사가개발자글쓰기교육을하자