문제와 문제점을 구별하자
•
체인지 로그는 몇 줄로 간단히 쓸 때가 많습니다. 그러나 기업에서 하는 사업에 따라 고객에게 제공해야할 때도 있습니다.
•
버그를 잡거나 새로운 기능을 추가하거나 성능을 개선하는 것은 모두 어떤 문제를 해결하기 위해서입니다.
•
문제를 해결한다는 것은 목표에 다다르지 못하는 문제를 해결함을 의미하며 발생형, 탐색형, 설정형으로 구분됩니다.
◦
발생형 문제는 당장 발생해 해결하기 위해 고민하는 문제입니다.
◦
탐색형 문제는 현재 상황을 개선하거나 효율을 높이는 문제입니다.
◦
설정형 문제는 미래 상황에 대응하는 문제입니다.
•
버그를 수정하는 것, 기능과 성능을 개선, 새로운 기능을 만드는 것 모두 문제를 해결하는 것입니다. 이때 문제와 문제점을 구별해야 합니다.
문제, 문제점, 해결책, 후속 계획 순으로 적자#
•
하나의 문제에 문제점은 여러 가지고, 여러 가지 문제점을 모두 해결하기에는 예산과 인력이 부족하므로 특정 문제점을 선택할 수 밖에 없습니다.
•
릴리스 문서는 결국 개발자가 문제점 하나를 선택해서 해결한 결과입니다.
•
문제: 사용자가 급증하면 서버가 정지
•
문제점: 잘못된 시스템 설정, 프로그램 비 최적화, 잘못된 DB 설계
•
해결책: 시스템 설정 변경
•
후속 계획: 프로그램 최적화, DB 재설계
법적인 문제를 고려해서 쓰자#
•
릴리 노트의 핵심은 문제 해결의 과정과 결과를 고객에게 알려주는 것입니다.
•
문서 정보: 제품명, 필리스 이름, 릴리스 버전, 릴리스 날짜 등
•
개요: 릴리스 노트의 주요 내용을 종합한 글
•
새로운 기능: 이번 릴리스에 새롭게 추가한 기능
•
개선 사항: 기존 기능을 향상하거나 안정성 등을 강화한 내용
•
버그 수정: 버그 내용과 수정 사항
•
영향과 주의사항: 릴리스로 인한 영향과 개발자의 주의사항
•
연락처: 문의나 의견 접수를 위한 담당자 이름과 연락처 번호
•
면책: 변경 사항이나 릴리스 문서로 인한 법적 문제 발생 시 책임의 한계에 관한 내용
Copy
•
릴리스 노트를 통해 거래 개발자에게 어떤 행동을 유도할 때는 그 행동이 필수인지, 권장인지, 선택인지를 명확히 알려줘야 합니다.
필수#
•
~해야 한다, ~하지 않으면 안된다, ~하면 안된다, ~해서는 안된다
권장#
•
~할 것을 권장한다, ~하는 것이 좋다, ~하는 것이 이상적이다
선택#
•
~할 수도 있다, ~해도 된다, ~하는 방법이 있다
