릴리즈 노트는 개발과정에서 정리된 릴리즈 정보를 소프트웨어의 고객과 공유하기 위한 문서이다.
소프트웨어의 기능, 서비스, 사용 환경 또는 지속적인 업데이트에 대한 정보를 확인할 수 있다.
개선된 작업이 있을 떄마다 관련 내용을 릴리즈 노트에 담아 제공한다.
개발팀에서 제공하는 소프트웨어 사양에 대한 최종 승인을 얻은 후 문서화 되어 제공된다.
초기 버전 작성 시 고려사항
정확하고 완전한 정보를 기반으로 개발팀이 직접 현재 시제로 작성한다.
신규 소스, 빌드 등의 이력이 정확하게 관리되어 변경 또는 개선된 항목에 대한 이력 정보들도 작성되어야 한다.
릴리즈 노트 작성에 대한 표준 형식은 없지만, 일반적으로 다음 항목이 포함된다.
요약: 머릿말, 개요, 목적, 문제 요약, 재현 항목, 수정/개선 내용, 사용자 영향도, SW 지원 영향도, 노트, 면책 조항, 연락처
머릿말(Header)
릴리즈 노트 이름, SW 이름, 릴리즈 버전, 릴리즈 날짜, 릴리즈 노트 날짜, 릴리즈 노트 버전 등
개요
소프트웨어 및 변경사항 전체에 대한 간략한 내용
목적
해당 릴리즈 버전에서의 새로운 기능, 수정된 기능의 목록, 릴리즈 노트의 목적에 대한 간략한 개요
문제 요약
수정된 버그에 대한 간략한 설명 또는 릴리즈 추가 항목에 대한 요약
재현 항목
버그 발견에 대한 과정 설명
수정/개선 내용
버그를 수정/개선한 내용을 간단히 설명
사용자 영향도
사용자가 다른 기능들을 사용하는데 있어 해당 릴리즈 버전에서의 기능 변화가 미칠 수 있는 영향에 대한 설명
SW 지원 영향도
해당 릴리즈 버전의 기능 변화가 다른 APP들을 지원하는 프로세스에 미칠 수 잇는 영향에 대한 설명
노트
SW/HW 설치 항목, 업그레이드, SW 문서화에 대한 참고 항목
면책 조항
회사 및 소프트웨어와 관련하여 참조할 사항(ex. 프리웨어, 불법 복제 금지 등)
연락처
사용자 지원 및 문의 응대를 위한 연락처 정보
추가버전 작성 시 고려사항
소프트웨어의 테스트 과정에서 베타 버전 출시, 긴급한 버그 수정, 업그레이드 등 자체 기능 향상과 사용자 요청에 따라 발생하는 경우 릴리즈 노트를 추가로 작성한다.
중대한 오류가 발생한 경우 릴리즈 버전을 출시하고 버그 번호를 포함한 모든 수정된 내용을 담아 릴리즈 노트를 작성한다.
소프트웨어에 대한 기능 업그레이드의 경우 릴리즈 버전을 출시하고 릴리즈 노트를 작성한다.
사용자로부터 접수된 요구사항 반영을 위해 추가/수정된 경우 자체 기능 향상과는 다른 별도의 릴리즈 버전으로 출시하고 릴리즈 노트를 작성한다.
릴리즈 노트 작성 순서
- 모듈 식별 - 모듈벌 빌드 수행 후 릴리즈 노트에 작성될 내용 확인
- 릴리즈 정보 확인 - 릴리즈 노트 이름, SW 이름, 릴리즈 버전 및 날짜, 노트 날짜 및 버전 등 확인
- 릴리즈 노트 개요 작성 - 소프트웨어 및 변경사항 전체에 대한 간략한 내용 작성
- 영향도 체크 - 버그/이슈 관련 내용 또는 해당 릴리즈 버전에서 기능 변화가 다른 소프트웨어나 기능을 사용하는데 미칠 수 잇는 영향에 대해 기술
- 정식 릴리즈 노트 작성 - Header, 개요 영향도 체크 항목을 포함하여 정식 릴리즈 노트 작성
- 추가 개선 항목 식별 - 추가 버전 릴리즈 노트 작성이 필요한 경우 작성