2023년 12월 3일 작성

개발자의 글쓰기

개발자의 글쓰기는 정확성, 간결성, 가독성이 중요합니다.

개발자의 글쓰기

  • 개발자의 글쓰기는 기획자나 관리자의 글쓰기와 다릅니다.
    • 기획자나 관리자의 글쓰기는 논리력, 설득력, 실행력이 중요합니다.
      • 기획서, 전략 보고서 등.
    • 개발자의 글쓰기는 정확성, 간결성, 가독성이 중요합니다.
      • class나 함수의 이름, 주석, 오류 message, release 문서, 개발 guide 등.
특징 의미 설명
정확성 틀림이 없이 확실한 것 쓰인 대로만 개발하면 bug 없이 실행됨
간결성 간단하고 깔끔한 것 군더더기 없이 핵심만 작성
가독성 쉽게 읽히는 것 쉬운 용어 사용, 표나 그림으로 잘 표현, 문단과 문서 전체에 체계와 위계 갖추기
  • 정확성, 간결성, 가독성은 서로 대치합니다.
    • 정확성을 높이면 간결성과 가독성이 낮아집니다.
    • 간결성을 높이면 정확성과 가독성이 낮아집니다.
    • 가독성을 높이면 간결성과 정확성이 낮아집니다.
  • 그럼에도 개발자는 정확하고 간결하고 가독성이 높은 글을 써야 합니다.
    • code 안에서는 함수와 변수 이름, 주석, 오류 message를 써야 합니다.
    • code 밖에서는 release note, 장애 보고서, 개발 guide를 써야 합니다.
    • 외주 개발을 한다면 SI 제안서의 기술 부문을 설득력 있게 써야 합니다.
    • 기술 blog를 운영한다면 개제할 글을 써야 합니다.

Reference

  • 개발자의 글쓰기 (도서) - 김철수

목차