개발자의 글쓰기

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

문장을 쉽게 쓰려면 간단한 문장 구조로 핵심만 말한 뒤, 필요에 따라 부가 설명을 한다.
비즈니스 문서에는 문단과 문단 사이에 위계가 있어야 한다. 위계는 위치와 계층을 합한 말이다.

조사, 순서, 숫자, 하다, 기호만 붙이고 나머지는 띄어 쓴다.
책의 제목이나 신문 이름을 나타내는 겹낫표, 겹화살괄호 대신 큰 따옴표,
소제목이나 예술작품의 제목, 상호, 법률, 규정 등을 나타낼 때 쓰는 홑낫표와 홑화살괄호 대신 작은 따옴표를 쓴다.

우리말 해석이 비슷해도, 미묘하게 다른 영어 표현을 적절하게 사용해야 한다.
영어를 한글로 적을때도 외래어 표기법에 따라 맞는 표현이 있다.
이미 굳어진 외래어는 관용을 존중하되, 그 법위와 용례는 따로 정한다. 국립국어원 홈페이지에 외래어 표기 용례가 있다.

모든 개발자는 자기 코드를 읽는 사람이 주석 없이도 금방 이해하게 코드를 작성하고 싶어 한다.
개발자가 컨벤션을 만든 이유는 가독성과 소통 때문이다.

약자는 상식적으로 이해하는 단어의 약자정도만 쓰는 것이 좋겠다.

S 검색하기 쉽고
M 조합하기 쉽고
A 수긍하기 쉽고
R 기억하기 쉽고
T 입력하기 쉬운 이름

이름을 잘 지으면 주석을 줄일 수 있다.
주석없이 코딩하는 연습을 하자

주석은 빌드에 영향을 주지 않기 때문에, 종종 최신화되지 않기도 한다.
주석도 코드라고 생각하고, 코드리뷰를 할때 주석 리뷰도 함께 꼼꼼히 해야 한다.

링크를 깨진채로 두지 않도록 하자.
개발자가 보는 에러와 사용자가 보는 에러를 분리하자.

사용자 에러메시지는 에러의 내용과 원인, 해결방법이 포함되어야 한다.
선택지 버튼에 예, 아니오 보다는 구체적인 행동을 표기하는 것이 좋다.

확인취소버튼의 순서는 OS마다 다른데, 서비스내에서는 일관성을 갖게 하는 것이 좋다.

사용자를 이해하면 에러메시지를 보이기 이전에 에러를 예방할 수 있다.