[개발자의 글쓰기] 1장 개발자가 알아야 할 글쓰기 기본

01. 문장과 단락을 구조화하는 법

문자을 구조화하는 법

색상 RGB 값을 각각 사용하기 때문에 입력 데이터는 3차원 벡터다

> 입력데이터는 색상 RGB 값을 각각 사용하기 때문에 3차원 벡터다.

> 입력데이터는 색상 RGB 값을 각각 사용한다. 그래서 입력데이터는 3차원 벡터다.

> 입력 데이터는 3차원 벡터다.

> 입력 데이터는 3차원 백터다. 색상 RGB 값을 각각 사용하기 때문이다.

문장을 쉽게 쓰기 위해서는, 간단한 문장 구조로 핵심을 만한 뒤, 필요에 따라 부가 설명을 하면 된다.

 

서술식, 개조식, 도식의 차이

• 서술식

'~다' 로 끝나는 완전한 문장으로 구성 된 글

• 개조식

'~했음, 종결어미' 로 끝내는 문장

• 도식

사물의 구조나 관계, 상태를 그림이나 서식으로 보여주는 것

개조식을 활용해 문장을 만들 떄, 서술 방식과 글머리 기호를 잘 활용해야한다.

또한, 단락을 구조화하는 위계도 중요하다. 이는 개발자가 코딩할 때 Tab 대신 띄어쓰기 하는 것을 빗대 설명할 수 있다.

계층이 표현되는 문서를 작성하는 것이 읽는 사람으로 하여금 체계를 빠르게 잡게 도와줄 수 있다.

 

02. 쉽게 쓰는 띄어쓰기와 문장 부호

띄어쓰기 원칙은

"조사, 순서, 숫자, 하다, 기호만 붙이고 나머지는 띄어 쓴다."

예를 들어

• 장애 가 발생 한 지 3 시간 이 지나 버려서 일 단계 대첵 이 무의미 하다( v.1.1.0)

조사를 붙인다.

• 장애가 발생 한 지 3 시간이 지나 버려서 일 단계 대책이 무의미 하다( v.1.1.0)

일,이,삼과 같은 한글 숫자가 순서나 단계를 나타낼 때는 뒤 낱말과 붙인다.

• 장애가 발생 한 지 3 시간이 지나 버려서 일단계 대책이 무의미 하다( v.1.1.0)

숫자는 모두 뒤 낱말과 붙인다

• 장애가 발생 한 지 3시간이 지나 버려서 일단계 대책이 무의미 하다( v.1.1.0)

'~하다'는 모두 앞 낱말과 붙인다

• 장애가 발생한 지 3시간이 지나 버려서 일단계 대책이 무의미하다( v.1.1.0)

마지막으로 기호를 모두 앞 낱말과 붙인다

• 장애가 발생한 지 3시간이 지나 버려서 일단계 대책이 무의미하다(v.1.1.0)

오해하기 쉬운 문장 부호(큰따움표, 작은따움표)

큰따옴표와 작은 따옴표를 구분하는 기준은 언어마다 다르지만, 글에서는 다음과 같은 기준을 가진다

책의 제목이나 신문 이름을 나타내는 경우 큰 따움표사용

• 이번에 출간된 "개발자의 글쓰기"를 참고했음
• 이 건은 "한겨례신문"의 기사를 토대로 작성했음

소제목이나 예술 작품의 제목,상호,법률,규정 등을 나타낼 때는 작은 따움표

또는, 어떤 내용을 가종하거나 비교해서 드러내야 할 때도 작은 따움표

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

일관성있는 단어를 선택해야 한다

반대 되는 말로는

Show <=> Hide

invisible <=> visible

head <=> tail, toe, foot

input <=> output

open <=> close

비슷한 말은 서로 의미는 비슷하지만 개발에서 사용되는 의도가 다르다

stop, end, finish, pause, suspend, hold 등의 중단이라는 의미에서

stop은 잠시 중단하는 것이여서 언제든 재시작 가능하다.

end는 완전히 중단되어 재시작할 가능성이 없다는 의미

finish는 끝장을 본 상태에서 재시작을 고려할 필요가 없다

pause 는 아주 잠시 일시적으로 중단된 것

suspend 다음 단계의 시작을 중단 한 것 

hold 어떤 의도가 있어서 중단 된 것

 

Get 이라는 말의 함수 이름으로 비슷한 단어는 retrieve 이는 검색해서 가져오다는 뜻으로, 검색에 무게를 줄 때 사용

acquire는 독점 한다는 뜻 즉, 다른 함수가 가져가지 못하게 독점하고자 할 때 사용

fetch는 현재 값을 가리키는 포인터가 다음 값으로 이동한 것을 가져온다는 뜻

Set 이라는 것은 값을 변경하거나 설정하는 함수에 사용하며, 초기화 설정이라면 init를 쓰는 것도 좋은 방법

create와 register도 비슷하지만 전혀 다른 역할

register는 이미 정해진 틀에 값을 집어넣는 것

create는 정해진 틀이 없으므로 먼저 틀을 만들 떄 쓴다.

수정을 나타내는 change, modify, revise도 의도가 다른 말

change는 내용을 단순히 바꾸는 것

modify는 잘못된 것을 바로잡을 때,

revise는 기존에 없던 새로운 정보나 아이디러르 덧붙여 기존 내용과 달라졌음을 분명히 할 때 사용

그외

parameter는 매개변수로, 함수에 정의한 변수를 뜻하고,

argument는 전달 인수로, 함수를 호출할 떄 전달되는 값

 

Must는 필수 요구사항

shoue는 권고 또는 권장 사항으로, 가능하면 지키거나 구현해야 한다.

---

1장에서 주의깊게 본 부분은 아무래도 같은 단어라도 미묘하게 다른 단어의 차이점을 알려주는 부분이였다.

아무래도 코드를 짜면서 그런 부분은 늘 어렵기 때문이다. 또한 글을 잘 쓴다는 것은 어떤것을 의미하는 바를 명확하게 알 수 있었다.

딱 개발자의 글쓰기 특징으로 딱 세가지만 기억하자.

정확성 > 틀림이 없이 확실한 것

간결성 > 글에 군더더기가 없고 간단하고 깔끔한 것

가독성 > 쉽게 읽히는 것

이 3가지만 명심하고 글을 쓰는데, 주의를 기울이며 작성하자.