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

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

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

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

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

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

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