[자기개발/개발자] 개발자로서의 글쓰기 연습 #15

Chapter4.3 - 릴리스 문서는 문제 해결 보고서처럼 쓰자

---

문제와 문제점을 구별하자

• 목표: 바람직한 상태, 기대되는 결과

• 현상: 현재 모습, 예기치 못한 결과

• 현상을 목표에 일치시키기

• 문제의 3가지 종류

  • 발생형 문제: 당장 해결해야할 문제 / 원상 복구 필요 / 프로그램 에러가 대부분
  • 탐색형 문제: 현 상황 개선, 효율 상승 / 놔두면 해결할 수 없는 문제로 커짐 / 프로그램개선이나 시스템 효율화가 대부분
  • 설정형 문제: 미래 상황에 대응 / 새로운 기능, 대폭적인 업그레이드가 대부분

• 문제와 문제점을 구분하기(도식화)

문제, 문제점, 해결책, 후속 계획 순으로 적자

문제: 사용자가 급증하면 서버가 정지
문제점: 잘못된 시스템 설정, 프로그램 비 최적화, 잘못된 DB설계
해결책: 시스템 설정 변경
후속 계획: 프로그램 최적화, DB 재설계

000 서비스에 사용자가 급증하면 00서버가 정지하는 문제는 시스템 재설정으로 해결했습니다. 추후 프로그램 최적화와 DB 재설계도 검토하겠습니다.

법적인 문제를 고려해서 쓰자

• 면책 조항을 꼭 적는 것이 좋음
• 어떤 행동을 유도할 때는 그 행동이 필수인지, 권장인지, 선택인지 명시

필수

• ~해야 한다.
• ~하지 않으면 안된다.
• ~하면 안된다.
• ~해서는 안된다.

권장

• ~할 것을 권장한다.
• ~하는 것이 좋다.
• ~하는 것이 이상적이다.

선택

• ~할 수도 있다.
• ~해도 된다.
• ~하는 방법이 있다.

개발자에게 면책은 개발의 한계이자 도전 대상

참고문헌: 개발자의 글쓰기