개발자의 글쓰기 1장 정리

🌿 프롤로그 : 개발자의 글쓰기는 달라야 한다

개발자 글쓰기의 특징: 정확성, 간결성, 가독성

• 정확성 : 틀림이 없이 확실한 것.
  • 글로 쓰인대로만 개발하면 버그없이 실행돼야 함
• 간결성 : 핵심만 써야 함.
• 가독성 : 쉬운 용어를 사용하고 필요하다면 표나 그림으로 잘 정리해야 함.

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

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

• 문장을 쉽게 쓰려면 간단한 문장 구조 핵심만 말한 뒤, 필요에 따라 부가 설명을 한다.
  • 첫 문장의 주어를 소제목으로 만들면 자연스럽게 문단을 구성할 수 있다.

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

1. 서술식 : ‘~다’로 끝나는 완전한 문장으로 구성된 글.
   • 무엇을 설명하거나 논증할 때
   • 줄거리가 있는 설명이나 이야기
   • 개발 가이드 문서
2. 개조식 : 신문의 헤드라인, 어떤 사항을 나열 할 때.
   • 명사나 용언의 명사형(‘~했음’)으로 끝내는 것
   • 릴리스 문서, 장애 보고서, 여러 사항이 유사한 패턴으로 반복될 때
   • 글머리 기호를 꼭 써야 함.
     • 쓰임새에 따라 적절히 사용해야함
       • 설명: 내용을 구체적으로 설명하거나 나열할 때, 하위 요소로 갈수록 부가 설명
       • 묘사: 내용을 그림으로 나타낼 때 그림 안에 어떤 요소나 영역을 표시하기 위해 원형문자를 사용
       • 논증 : 귀납, 연역, 인과, 유추, 비교 단계 등 ( <, > , = , 화살표 등)
       • 서사 : 순서나 단꼐를 나타낼 때 숫자나 문자 사용
   • ※ 중복과 누락이 있다. => 도식을 사용 (ex. 표)
3. 도식 : 사물의 구조나 관계, 상태를 그림이나 서식으로 보여주는 것.
   • 각 항목이나 사항의 관계를 명확히 규정할 때.

• ※ 중요한 것은 내용과 형식이 일치해야 한다.
• ※ 비즈니스 문서에는 반드시 계층을 표현한다.
  • 계층을 표현하면 문서의 체계를 먼저 이해할 수 있으므로 읽는 시간이 덜 걸린다.
• 글을 쓸 때는 항상 위계가 잘 드러나게 글을 쓰고 표현해야 한다.

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

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

• 비즈니스 문서에서 큰 따옴표는 책의 제목이나 신문 이름을 나타낼 때 씀.
• 작은따옴표는 소제목이나 예술 작품의 제목, 상호, 법류, 규정 등을 나타낼 때, 어떤 내용을 강조하거나 비교해서 드러내야 할 때 씀.

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

• 반대말을 정확히 사용해야 한다.
• ex. show <-> hide (o), show <-> invisible (x)
• 비슷한말은 사용하는 의도에 따라 써야한다.

중단을 의미하는 단어

다른 예시는 책 참고

• 정확한 단어를 쓰는 것도 중요하지만 더 중요한 것은 얼마나 일관성있고 개연성 있게 쓰느냐다.