​#개발자

들 또한 언제나 #글쓰기 에 노출되어 있다.글이란 나의 생각을 상대방에게 전달하는 힘이다.​개발자는 프로그래밍(개발)하는 것 자체가 글쓰기라고도 할 수 있다.어떤 클래스, 함수, 변수 명을 무엇으로 지을것 인가는 영어권이 아닌 이상 항상 숙제일 것이다.​이 책은 실무적으로 우리가 만나게 되는 글쓰기에 대한 #지침서 다.글을 잘쓸 필요는 없지만 잘쓴다면 우리가 얻는건 많아 질것이다.​​​​프롤로그 개발자의 글쓰기는 달라야 한다​- 기획자나 관리자의 글쓰기: 논리력, 설득력, 실행력 중요- 개발자의 글쓰기: 정확성, 간결성, 가독성 중요​- 이 책은 개발자의 글쓰기 능력을 종합적으로 향상아기 위한 책이다.- 코딩과 마찬가지로 글쓰기도 과학이고 기술이다.- 누구나 체계적으로 배우기만 하면 글을 잘 쓸 수 있다.​​​​1장.개발자가 알아야 할 글쓰기의 기본​[문장을 구조화하는 법]​☞ 예시>- 간단한 문장 구조(주어+서술) 핵심만 말한뒤,- 필요에 따라 부가 설명- 문장의 주어로 소제목 만들면 문단 구성​☞ 예시 변경후 >​[생각을 글로 표현방법]- #서술식 : ~다 로 끝나는 완전한 문장- #개조식 : 해드라인, 나열식, 명사형 등 릴리즈 문서 및

장애보고서 - #도식 : 사물의 구조나 관계, 상태를 그림으로 표현, 도표, 표​​[개조식 서술 및 글머리 기호]진술방식내용글머리 기호설명- 내용을 구체적 설명, 나열■, □, ○, ●, -, *, ※, √ 등묘사- 내용을 그림으로 표현ⓐ, ⓑ, ⓒ, ①, ②, ③ 등논증- 내용이 논리관계 (귀납,연역,인과, 유추 등)∴, ∵, →, ⇒, ☞, 〉, 〈, =등서사- 순서나 단계1, 2, 3, 가, 나, 다 등☞ 예시>- #비지니스_문서 에는 문단과 문단 사이에 위계(위치와 계층)가 있어야 한다.- #문서 를 작성 할 떄는 꼭 탭이나 스타일을 사용- 문서에는 계층은 굵기, 모양, 밑줄, 줄 간 거리 등으로 표현​​- 띄워쓰기 원칙 : 조사,순서,숫자,하다,기호만 붙이고, 나머지는 띄어 쓴다​- C(언어) 작은따옴표 단일문자, 큰따옴표 문자열​​2장.개발 시간을 줄여주는 이름 짓기와 주석 쓰기​☞ 해당 부분은 나에게 매우 유용한 단락이려서 따로 자세히 포스팅해 올렸다.​프로그래밍시 #네이밍 을 위해 우리는 생각보다 많은 시간을 보낸다. 또는 그 네이밍을 위해 구글 한영 변...​3장.사용자와 소통하는

에러 메세지 쓰기​- 사이트안에 깨진 링크 찾아내는 서비스Check websites for broken links online using this free tool. Find 404 errors to improve your SEO rankings.- 구글 검색엔진에서 특정 사이트 깨진 링크 찾기Improve your performance on Google Search Search Console tools and reports help you measure your site's Search traffic and performance, fix issues, and make your site shine in Google Search results Start now Optimize your content with Search Analytics See which queries bring users to your site. Anal...​- 개발자용 #에러_메세지 와 사용자용 에러 메세지 분리해 작성- #define 이용 여러 에러 메세지를 한 번에 쉽게 관리​- 에러 메세지 보여주는 순서 : [에러해결방법] &gt[에러원인] &gt[에러내용]- 버튼 메세지는 행동을 분명히 표시 - 짧고 애매한 것보다 길더라도 분명하게 표현​- 에러를 줄이려면 개발자도 사용자의 방식을 이해해야한다.- 에러 메세지 대신에 예방 메세지를 보여줌으로써 에러 발생을 막을 수

있다.​- 개발자가 사용자를 불완전한 존재로 인식하는 순간 모든 사용자의 행동에 경고로 대응한다.- 그러면 시스템도 불완전 해진다.​​​4장.독자 관점에서 릴리스 문서와 장애 보고서 쓰기​[체인지 로그]■ 1단계 선정하기- 개발자의 노력과 독자의 관심을 기준으로 우선순위화- 회사 입장 투영 : 사업팀, 디자인팀, 마케팅팀, 운영팀의 관심개발자가노력을 많이 들인 것노력을 덜 들인 것독자가관심 있는 것1순위2순위관심 없는 것3순위삭제■ 2단계 분류하기- 기능 추가, 기능 개선, 오류 수정- 게임 준비, 게임 중, 게임 종료​■ 3단계 요약하기- 요약 방법을 통한 개조식 문장으로 축약​■ 4단계 종합하기- 내용 전체를 종합 한문장으로 대표 문장 체인지 로그 첫 줄사용자 편리성 개선​■ 게임방에 더 빨리 입장■ 게임 결과 바로 확인​[세부 내용]​■ 게임 준비 - 미리 보기 리부팅 문제 해결 - 빈 게임...​■ 게임 준비 - 미리 보기 리부팅 문제 해결 ....​■ 게임 준비 - 미리 보기 리부팅 문제 해결 ...​​[Semantic Versioning] 유의적 버전​1 버전 1.2.2 -&gt1.2.3- 간단한 패치,

버전(1.2.x)와 호환​2. 버전 1.2.2 -&gt1.3.0- 세 번째 자리 0으로 초기화, 새로운 기능 초기화- 일부 호환, 새로운 기능을 1.2.x 에서 사용 불가​3. 버전 1.2.2 -&gt2.0.0- 전면적인 업그레이드, 이전 버전과 거의 호환 불가- 완전히 다른 프로그램으로 이해​Semantic Versioning spec and websitesemver.org​​[장애보고서]​- 질문에 대답라는 신속한 글쓰시- 원인과 이유를 찾는 분석적 글쓰기- 상사를 고려하는 비지니스 글쓰기- 원하는 것을 얻는 정치적 글쓰기​장애 보고서제목: 서버 모듈 변경 문제로 사용자 결제 불가(10~11시)항목내용장애 내용사용자 결제 불가(10:00~11:00, 1시간)장애 영향장애 중 결제 시도 100건 -&gt1시간 후 결제 비율 10%(평균 50%) 장애 원인서버 쪽 결제 모듈 변경시 모듈 인터페이스의 함수를 수정했으나 ....조치 상황서버 쪽의 바뀐 함수를 호출하도록 프런트 코드 수정조치 결과결제 기능 정상 작동핵심 원인서버 쪽과 프런트 쪽 커뮤니케이션 단절향후 대책서버, 프런트 팀장이 소통 방법 협의하여 보고장애 발생 가능성표현1%절대 발생하지 않는다10%재발하지 않는다20%재발할지도 모른다30%재발할 수도 있다40%재발한다고 볼 수도 있다50%재발할수 있다60%재발하지 않는다고 볼 수 없다70%재발한다고

보여진다80%재발한다90%재발할 것이 틀림없다99%반드시 재발한다- 혼란스러운 말들이다....위 표를 좀더 그룹핑해서 4~5 단계로 분류해보자.​5장.설명, 묘사, 논증, 서사로 개발 가이드 쓰기​- 개발자가 독자에게 서비스 개념을 설명할 때 범주,용도,특징 순으로 작성- #범주: 서비스의 정체성과 검색어와 연관- #용도: 독자가 이 서비스를 이용하는 이유- #특징: 차별화 내용, 장점(자기기준)과 강점(경쟁비교)​- 묘사는 어떤 대상이나 사물,현상을 언어로 서술하거나 그림을 그려서 표현- 시각, 청각, 후각, 미각, 촉각 묘사​- 개발자가 주관적 묘사와 객관적 묘사 둘 다 잘하면 - 기획자나 디자이너와 협의 할때 주도권을 가질 수 있다- 개발자가 주도권을 가지면 비교적 개발이 쉬워지고 나중에 변경 할 것도 줄어든다​- 논증은 옳고 그름을 이유나 근거를 들어서 밝히는 것- 논술은 논증의 기법으로 기술하는 것, 논술의 핵심이 논증​- 개발문서는 독자에게 여지를 줘서 안된다.- 개발문서가 너무 공손하면 독자를 가이드 할 수 없다.- 주장을 했으면 이유를 바로 이어서 말해야 한다.​- 서사는 사실을 그대로 순서대로 적는 것- 글이 많지 않는 경우,

한 문장으로 요약하고 단어 앞에 번호 기입- 개발자는 어떤 행동에 의미를 두고 글로 쓸지 직접 결정​- 개발문서에서 서사는 개발자와 독자 사이의 줄다리기- 개발자는 의미 없는 것은 빼고 중요한 것을 넣기를 원한다- 독자도 의미 있는 것만 남고 무엇이 중요한지 구별해 주기를 원한다.​- 좋은 방법은 기술의 범용성을 기준으로 하는 것- 다른방법, 개발문서를 읽기 전에 기본적인 수준으로 맞춰 놓는것​​6장.수주를 돕는 SI 제안서 쓰기​[제안서 요청분석]- 제안요청서 제대로 분석- 모든 문제와 답은 제안 요청서에 들어 있다.​[논리적 완결성]- 항목을 논리적으로 완결- 관심 있는 항목, 또는 특정 페이지만 골라 읽는다.​☞ 예시>시스템 구성도 작성시,- 고객의 요구사항, 고려사항, 기대효과- 구성 전략, 구성 목표, 구성 방안, 구성의 특장점등의 내용 포함제안사의 문제 해결 능력탁월함부족함고객의 문제 인식중대함① 경쟁사와 비교하여 제안하라② 일단 동감하고 다른 방안을 제시하라사소함③ 고객이 문제를 중대하게 인식하게 만들어라④ 경쟁사의 전략을 확인하여 대체하라​- 개발은 고객의 #요구사항 을 실현하는 것​- 고객은 자기가 원하는 제품이

정확히 뭔지 모른다- 고객에게 요구사항을 제시해서 고객이 선택하게 만들어야 하고 선택에 따라 개발해야한다​- 요구사항은 반드시 변한다- 요구사항 정의와 구현, 고객의 검수 사이의 시간 차이를 줄이는 것이다.​카노 모델- 기능의 성능 요구는 한계를 정해야 한다.- 특별한 기능은 하나쯤 만들어야 한다.- 특별한 기능 하나가 개발자의 다른 문제를 해결해 줄 수 있다.​​​7장.기술 블로그 쉽게 쓰고 운영하기​[첫째, 소재 우선 글쓰기]- 소재 의식은 특정한 대상이나 상황에 대한 자기만의 관점이나 생각이나 해결방안​[둘째, 자기 수준 글쓰기]- 독자를 생각해서 어려운 용어를 일부러 해석해 풀어쓰거나 쉬운 용어 바꿀 필요 없다.- 실력이 비슷한 독자를 위한 것​[셋째, 재미있는 글쓰기]- 글쓰기 #기교 는 글을 아름답게 만들고 쉽게 읽히게 한다.- 독자가 활발하면 블로거는 글을 계속 쓸 동력을 얻는다.- 글쓰기 기교는 이렇게 선순환을 만든다.​​에필로그.회사가 개발자 글쓰기 교육을 하자​#김철수 #위키북스 #네이밍 #릴리즈노트 #장애보고서 #기술블로그 #프로그래머 #유의적버전 #제안서