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

오직 개발자를 위한 글쓰기의 모든 것을 담았습니다!

이 책은 개발자의 글쓰기 능력을 종합적으로 향상하기 위한 책이다. 코드 안에서는 함수와 변수 이름을 짓는 것부터 주석 쓰는 법, 에러 메시지 쓰는 법까지 알려준다. 코드 밖에서는 릴리스 노트, 장애 보고서, 개발 가이드를 어떻게 하면 잘 쓸 수 있는지를 알려준다. 외주 개발을 하는 개발자를 위해 SI 제안서의 기술 부문을 설득력 있게 쓰는 법도 놓치지 않았다. 블로그를 운영하려는 개발자나 IT기업을 위해 기술 블로그를 쓰는 법과 운영하는 팁도 담았다.

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

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

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

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

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

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

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

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

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

회원리뷰 총 0개

리뷰작성 새 창

사용후기가 없습니다.

등록된 상품문의

상품문의 총 0개

문의작성 새 창

상품문의가 없습니다.

[반품/교환가능 기간]

변심반품의 경우 수령 후 14일 이내, 상품의 결함 및 계약내용과 다를 경우 문제점 발견 후 30일 이내

[반품/교환비용]

단순 변심 혹은 구매착오로 인한 반품/교환은 반송료 고객 부담

[반품/교환 불가 사유]

- 소비자의 책임 있는 사유로 상품 등이 손실 또는 훼손된 경우

(단지 확인을 위한 포장 훼손은 제외)

- 소비자의 사용, 포장 개봉에 의해 상품 등의 가치가 현저히 감소한 경우

예) 화장품, 식품, 가전제품(악세서리 포함) 등

- 복제가 가능한 상품 등의 포장을 훼손한 경우

예) 음반/DVD/비디오, 소프트웨어, 만화책, 잡지, 영상 화보집

- 소비자의 요청에 따라 개별적으로 주문 제작되는 상품의 경우 ((1)해외주문도서)

- 디지털 컨텐츠인 eBook, 오디오북 등을 1회 이상 다운로드를 받았을 경우

- 시간의 경과에 의해 재판매가 곤란한 정도로 가치가 현저히 감소한 경우

- 전자상거래 등에서의 소비자보호에 관한 법률이 정하는 소비자 청약철회 제한 내용에 해당되는 경우

* (1) 해외주문도서 : 이용자의 요청에 의한 개인주문상품으로 단순변심 및 착오로 인한 취소/교환/반품 시

‘해외주문 반품/취소 수수료’ 고객 부담 (해외주문 반품/취소 수수료 : ①양서-판매정가의 12%, ②일서-판매정가의 7%를 적용)

[상품 품절]

공급사(출판사) 재고 사정에 의해 품절/지연될 수 있으며, 품절 시 관련 사항에 대해서는 이메일과 문자로 안내드리겠습니다.

[소비자 피해보상, 환불지연에 따른 배상]

- 상품의 불량에 의한 교환, A/S, 환불, 품질보증 및 피해보상 등에 관한 사항은 소비자분쟁해결 기준 (공정거래위원회 고시)에 준하여 처리됩니다.

- 대금 환불 및 환불지연에 따른 배상금 지급 조건, 절차 등은 전자상거래 등에서의 소비자 보호에 관한 법률에 따라 처리함.