개발 서적/개발자의 글쓰기

[개발자의 글쓰기] 1장. 개발자의 글쓰기는 달라야 한다

눙엉 2022. 1. 24. 02:04

이 글은 "개발자의 글쓰기"를 읽고 좋은 구절들을 기록하거나 느낀 점을 기록하는 글입니다.

개발자의 글쓰기

 

개발자의 생각을 글로 표현하는 3가지 방법

  1. 서술식
    '~다'로 끝나는 완전한 문장으로 구성된 글 (줄거리가 있는 설명이나 이야기)
  2. 개조식
    어떤 사항을 나열할 때 ( 여러 가지 종류의 항목과 내용이 반복되거나 서술식에서 강조가 필요한 내용)
    글머리 기호를 써야 한다.
  3. 도식
    그림이나 서식으로 보여주는 것 ( 각 항목이나 사항의 관계를 명확히 규정할 때 )

 

영어 단어 선택과 외래어 표기법

예를 들어 리액트에서 어떤 컴포넌트를 보여줄 때 show, hidden을 사용하는데 hidden대신에 invisible을 사용하면 안 된다.

 

invisible의 반대말은 visible이기 때문이다. 이처럼 비슷한 뜻을 가진 영단어가 많이 있다.

 

또한 수정을 나타내는 change, modify, revise에서

 

change는 단순히 내용을 바꾸는 것, modify는 잘못된 것을 바로잡을 때, revise는 기존에 없던 새로운 것을 덧붙여 기존 내용가 달라졌음을 나타낸다.

 

하지만 책에서는 정확한 단어를 쓰는 것도 중요하나 일관성 있고 개연성 있게 쓰는 것을 강조한다.

 

이렇게 비슷한 단어지만 의미하는 바가 다르니 변수명이나 함수명을 생각할 때 조금 더 유의해야 되겠다.