개발자들을 위한 테크니컬 라이팅 10계명

- 필수 문장 성분 생략하지 않기
- 문장 성분의 호응 지키기
- 조사 올바르게 사용하기
- 피동형/사동형 지양하기
- 이중 부정 지양하기
- 명확한 표현 사용하기
- 순서와 목록 구분하기
- 개조식 활용
- 맞춤법/띄어쓰기 체크하기
- 외래어 표기 체크하기

[xguru]

- 테크니컬 라이팅 4대 원칙 https://news.hada.io/topic?id=5409
- 퇴고의 기술 - 개발자의 기술문서 작성법 https://news.hada.io/topic?id=5446

[hongminhee]

프로그래머의 경우 외래어 표기법은 사실상 영어만 신경쓰면 되는데, 한국어 외래어 표기법은 철자법이 아니라 실제 발음을 기준으로 삼는다는 점, 그리고 영어는 철자법이 발음을 제대로 반영하지 않으므로 단어의 스펠링이 아닌 발음 기호를 보고 옮긴다는 점을 유념하시면 실수가 적습니다.

잘 모르겠으면 1) 국어 사전에 해당 영단어를 그냥 찾아서 나오면 그걸 쓰고 2) 안 나오면 영어 사전에 해당 단어 찾아서 국제 음성 기호(IPA)를 보고 표기를 유추하면 됩니다. 단, 외래어 표기법 규정은 영어에 대해서는 영국식 발음을 본으로 삼기 때문에 의외의 표기가 나올 때도 종종 있습니다.

영어가 아니면 한글라이즈(https://hangulize.org/) 같은 걸 쓰면 편한데, 영어가 철자법이 엉망이라 저렇게 기계적으로 하기가 어렵고, 꼭 사전이 필요하다고 합니다. (신조어 같은 경우에는 사전에 등재되어 있지 않아서 유튜브 같은 곳에서 해당 단어를 사람들이 어떻게 발음하고 있는지 확인해야 하는 경우도 있습니다.)