객체지향의 사실과 오해
변수 네이밍부터 릴리스 노트, 장애 보고서, 기술 블로그까지! | 프로그래머의 글쓰기 고민 끝!
목적
글쓰기 능력을 종합적으로 향상
학습 상태
- 1장: 개발자가 알아야 할 글쓰기 기본
(2024.04.17) - 2장: 개발 시간을 줄여주는 이름 짓기와 주석 쓰기
- 3장: 사용자와 소통하는 에러 메시지 쓰기
- 4장: 독자 관점에서 릴리스 문서와 장애 보고서 쓰기
- 5장: 설명, 묘사, 논증, 서사로 개발 가이드 쓰기
- 6장: 수주를 돕는 SI 제안서 쓰기
- 7장: 기술 블로그 쉽게 쓰고 운영하기
학습 메모
1장: 개발자가 알아야 할 글쓰기 기본
생각을 글로 표현하는 3가지 방식
- 서술식 : 단순히 문장으로 표현
- 개조식 : 명사형으로 쓰는 것 (주로 리스트)
- 도식 : 사물의 구조나 관계, 상태를 그림이나 서식으로 표현
단락을 구조화하는 위계
- 코드에서는 들여쓰기를 통한 위치는 맞울 수 있지만, 계층을 맞출 수 없기 때문에, 개발자가 쓴 글은 마치 메모장으로 문서를 작성한 느낌이 든다.
- 굵기, 모양, 밑줄, 줄간격 등으로 계층을 신경쓰자
올바른 영어 단어 선택하기
- show의 반대말은 hide이기 때문에, show 이후에 invisible을 쓰면 어색하다.