개발자 글쓰기

개발자 글쓰기 요약

• 기획자나 관리자의 글쓰기에 논리력, 설득력, 실행력이 중요하다.
• 개발자의 글쓰기에는 정확성, 간결성, 가독성이 중요하다.

정확성 - 틀림없이 확실한 것을 말한다. 글로 쓰인 대로만 개발하면 버그없이 실행돼야 한다.
간결성 - 글에 군더더기가 없고 간단하고 깔끔한 것을 말한다. 구구절절 설명하는 것이 아니라 핵심만 써야 한다.
가독성 - 쉽게 읽히는 것을 말한다. 쉬운용어를 사용하고 필요한다면 표나 그림으로 잘 정리해야 한다. 문단과 문서 전체에 체계와 위계가 잘 갖추어져야 한다.

• 트레이드오프
  정확성을 높이면 간결성과 가독성이 낮아진다.
  간결성이 높이면 정확성과 가독성이 낮아진다.
  가독성이 높이면 간결성과 정확성이 낮아진다.

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

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

이 문장에 주어는 "입력데이터"이다.
주어를 문장의 처음으로 뺄수 있다.

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

두문장으로 나눌 수 있다.
"입력데이터는 색상 RGB 값을 각각 사용한다. 그래서 입력데이터는 3차원 벡터다."

본인이 잘 아는 내용. 즉 '입력데이터는 3차원 벡터다'를 떠올리면 된다.

"입력데이터는 3차원 벡터다."
3차원 벡터인 이유를 어떻게 설명할 것인지 결정하면된다.

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

이때 첫문장의 주어를 가져다가 소제목으로 만들면 자연스럽게 문단을 구성할 수 있다.

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

서술식은 바로 앞의 문장처럼 ~다로 끝나는 완전한 문장을 구성된 글
무엇을 설명하거나 논증할때 주로 사용방식, 개발 가이드 문서 등

개조식은 신문의 헤드라인을 쓰거나 어떤 사항을 나열할 때 사용한다.
행사의 개요를 적을 때 일자, 장소, 참가자 등 종결 어미 대신 명사(완료, 증대 등)나 용언의 명사형(~했음)으로 끝내는 것을 개조식라고 한다.
주로 릴리스 문서나 장애 보고서를 쓸때

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

 

개발자의 글쓰기 - 김철수 지음