초급개발자가 봐야할 글쓰기 기술 '개발자의 글쓰기' 김철수 저

'개발자의 글쓰기' 김철수 저

개발자의 글쓰기 -김철수

 

>책을 읽게된 동기

이번 학기를 마칠 즈음에 내 프로젝트를 하나 완성해서 보고서를 작성하는데 글을 쓰기가 굉장히 힘들었던게 계기가 아니었나 싶다. 그리고 이후에 블로그 글을 직접쓰고 싶은데 조금 다듬어진 글을 봐야 사람들이 볼 것이라고 생각되어 이 책을 집게 되었다.

 

>메모들

 

• 말하고자 하는 내용의 설명-> 말하고자 하는 내용을 주어로 하는 것이 중요하다. 이후로 필요하거나 독자에 따라 부가 설명을 더 넣거나 생략하는 방식으로 하는게 좋다.
• 서술식, 개조식, 도식을 내용이 누락되지 않도록 표현해야 한다.
• 띄어쓰기 원칙= 조사, 순서, 숫자, 하다, 기호만 붙이고 나머지는 띄어쓴다. 사실 인터넷으로 글을 고치는 것이 가장 좋다.
• 파스칼 표기법 -> 모든 첫 단어를 대문자로 ex) 클래스명명
• 카멤표기법->첫문자를 제외한 문자 처음을 대문자 ex) 함수나 변수등에 사용
• 이름짓기는 조합이다.
• http://hangulize.org : 영어가 아닌 사이트를 번역-> papago나 구글번역 사용해도 무관
• 함수네이밍->할 내용을 적고 필요없는 내용이나 중간과정등을 축약해 함수이름을 정한다.
• '제목--내부사항__상태'로 네이밍을 한다.
• 좋은이름 짓기 SMART 중 S에서 범주화로 찾아서 이름을 쉽게 만들수 있다.
• 주석보다는 네입밍에 신경쓰기 (코드는 의미를, 주석은 의도를)
• 깨진 링크를 찾아주는 사이트가 존재한다.
• 버전 X.Y.Z 로 작성하며 첫개발은 0.1.0으로 시작한다. 코드를 개방했다면 1.0.0으로 버전을 맞춘다.
• 이후 다양한 내용이 있었으나 비즈니스적인 내용이 많아 훑어 넘기고 기술 블로그 작성법으로 넘어갔다. -> 책에서 비즈니스적인 내용을 봤음을 파악했다면 상관없다.
• 글은 자기 수준에 맞게 쓰자->블로그를 보는 사람을 특정할 수 없기에
• 글을 조금 재치있게 적어보자-> 재밌게 적고는 싶으나 공대생이라 마음처럼 잘 되지 않는다.

 

• 저.술.편.집 을 통해서 글감을 정할 수 있다.
• 저-직접 경험하고 실험한 과정이나 결과
• 술-어떤 것을 분석하여 의미를 풀이하고 해석한 것
• 편-산만하고 복잡한 자료를 편집해 질서를 부여한 것
• 집-여러 사람의 견해나 흩어진 자료를 한데 모아 정리한 것
• 이 내용이 이 책에서 나한테 가장 중요한 정보가 아니였나 싶다.

 

• 책에서 나에게 필요한 내용이나 정보등을 수집하기 위해서 메모를 하면서 책을 읽었지만 이번 책은 자세히 적다보니 책의 진도도 잘 나가지 않고 어째 책을 느낀 게 아니라 책을 정보를 수집하기 위해서 사용한 것 같다. 다음에 적을 때는 정말정말 필요한 정보만 담거나, 어떤 문장이나 내용에 관해서 고민, 견해등을 써보도록 하자

 

• 막상 첫 글을 써보니 영 보기도 불편하고 잘 쓴 것 같지는 않다. 하지만 이후로 조금씩 고쳐나가다 보면 언젠간 좋은 글이랑 내용이 써지지 않을까 싶다.

>다음 책: '프로그래밍 언어도감' 마스이 토시카츠 저