Skip to main content

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

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

문장을 구조화하는 법#

// before
색상 RGB 값을 각각 사용하기 때문에 입력 데이터는 3차원 벡터이다.
// after
입력 데이터는 3차원 데이터이다. 색상 RGB 값을 각각 사용하기 때문이다.
  • 문장을 쉽게 쓰려면 간단한 문장 구조로 핵심만 말한 뒤, 필요에 따라 부가 설명을 하면 됩니다.

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

  • 개발자의 생각을 글로 표현하는 방식은 크게 세가지가 있습니다.
    • 서술식
    • 개조식
    • 도식
  • 중요한 것은 내용과 형식이 일치해야합니다.
    • 줄거리가 있는 설명이나 이야기는 서술식으로 써야합니다.
    • 여러 가지 종류의 항목과 내용이 반복되거나 서술식에서 강조가 필요한 내용으로 개조식을 써야함
    • 각 항목이나 사항의 관계를 명확히 규정하고 싶다면 도식으로 써야합니다.

개조식 서술 방식과 글머리 기호#

  • 글을 개조식으로 쓸 때는 글머리 기호를 꼭 써야합니다.
    • 설명 : 기호...
    • 묘사 : (a), (b), (c), (1), (2), (3)
    • 논증 : ->
    • 서사 : 1, 2, 3, 가, 나, 다

단락을 구조화하는 위계#

  • 비즈니스 문서에는 문단과 문단 사이에 위계가 있어야 합니다.
  • 사람은 계층이 없는 문서를 보면, 이해하기가 어렵습니다.
  • 글을 쓸 때는 항상 위계가 잘 드러나게 글을 쓰고 표현해야 합니다.

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

가장 쉬운 띄어쓰기 원칙#

  • 조사, 순서, 숫자, 하다, 기호만 붙이고 나머지는 띄어 씁니다.
  • 맞춤법 교정해줄 교정 사이트 쓰는 것도 좋습니다.

오해하기 쉬운 문장 부호(끈따옴포, 작은따옴표)#

  • 코드 언어마다 다릅니다.

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

비슷한 듯 다른 듯, 단어 선택#

  • 단어는 신경써야하고, 반대말도 잘써야합니다.
    • showhide, visibleinvisible로 반대이며 다릅니다.
    • change, modify, revise도 의도가 다릅니다.
      • change는 내용을 바꾸는 것, modify는 오류를 수정하는 것, revise는 기존에 없던 새로운 정보나 아이디어를 덧붙여 기존 내용과 달라질 때 사용합니다.
    • must는 필수 요구 사항이고, should는 권고 사항입니다.

외산 제품 표기와 외래어 표기법#

  • 외산 제품이나 외래어 표기법은 반드시 동일하게 사용해야 합니다.
  • 국립국어원 외래어 표기 용례 찾기
Last updated on