릴리즈 노트 작성 시 고려 사항, 초기 버전 릴리즈 노트 작성 항목 - 릴리즈 노트 작성 항목, 릴리즈 노트 추가 작성 및 개선 사항 발생의 예외 케이스

CODEDRAGON Development/Software Engineering

반응형

 

릴리즈 노트 작성 시 고려 사항

릴리즈 노트는 개발 팀에서 Ownership을 가지고 직접 작성하여야 한다. 현재 시제로 작성되어야 하며, 명확하고 정확하며 완전한 정보를 제공한다.

그리고 신규 소스, 빌드 등을 배포 시부터 이력을 정확하게 관리하여 진행한다. 따라서 개발자와 테스터가 함께 협업을 해야 하고 최초 및 변경, 개선 항목까지 연결되어 다음 항목에 대한 정보들이 릴리즈 노트를 통해 작성되어야 한다.

 

·       초기 버전 릴리즈 노트 작성 항목

·       릴리즈 노트 추가 작성 및 개선 사항 발생의 예외 케이스

 

 

 

초기 버전 릴리즈 노트 작성 항목

릴리즈 노트는 보통 특정 소프트웨어 릴리즈의 최근 변경 사항, 개선 사항 및 버그 수정을 간결히 요약한 것이다. 사실 개발 조직 차원에서의 릴리스 노트에 대한 표준 형식은 없다. 하지만 통상적으로 배포되는 정보의 유형과 사용자의 요구 사항에 기초하여 공통항목으로 아래의 항목이 정의되어야 합니다.

 

 

릴리즈 노트 작성 항목

작성항목

설 명

Header

문서 이름(릴리스 노트 이름), 제품 이름, 버전 번호, 릴리즈 날짜, 참고 날짜, 노트 버전 등

개요

제품 및 변경에 대한 간략한 전반적 개요

목적

릴리스 버전의 새로운 기능목록과 릴리스 노트의 목적에 대한 간략한 개요. 버그 수정 및 새로운 기능 기술.

이슈 요약

버그의 간단한 설명 또는 릴리즈 추가 항목 요약

재현 항목

버그 발견에 따른 재현 단계 기술

수정/개선 내용

수정 / 개선의 간단한 설명 기술

사용자 영향도

버전 변경에 따른 최종 사용자 기준의 기능 및 응용 프로그램 상의 영향도 기술

SW 지원 영향도

버전 변경에 따른 SW의 지원 프로세스 및 영향도 기술

노트

SW HW Install 항목, 제품, 문서를 포함한 업그레이드 항목 메모

면책 조항

회사 및 표준 제품과 관련된 메시지.

프리웨어, 불법 복제 방지, 중복 등 참조에 대한 고지 사항

연락 정보

사용자 지원 및 문의 관련한 연락처 정보

 

 



릴리즈 노트 추가 작성 및 개선 사항 발생의 예외 케이스

릴리즈 정보의 예외 케이스 발생에 따른 추가 및 개선 항목이 나타날 수 있으므로 릴리즈 노트의 항목이 추가될 수 있다. 테스트 단계에서 베타 버전이 출시되거나, 긴급 버그 수정, 자체 기능 향상 등의 특이한 케이스 등이 발생할 수 있으므로 이러한 경우에도 추가 항목이 작성되어야 한다.

 

구분

설명

테스트 단계에서의 베타 버전 출시

제품 소프트웨어의 차기 버전이나 신규 버전의 베타 버전 테스트 단계에서도 릴리즈버전으로 정보를 체크하여 릴리즈 노트를 작성할 수 있다. 이럴때는 자체에서 기준을 수립하여 현 베타 버전을 신규 소스로 하여 릴리즈를 할지, 예외 사항으로 베타 버전에 대한 릴리즈 노트를 따로 만들지 사전에 정의해야 한다.

긴급 버그 수정 시

긴급한 버그가 발견되어 이를 수정할 경우의 릴리즈 노트 작성이다. 보통 긴급히 버그가 수정되면 릴리즈 노트 작성을 놓치는 경우가 많다. 반드시 버그 번호를 포함한 모든 수정된 버그를 기술하여 릴리즈 노트에 추가한다.

자체 기능 향상을 포함한 모든 추가 기능의 향상

자체적으로 기능 개선을 완료했을 때 정식으로 릴리즈 버전을 추가하고, 이에 따른 신규 릴리즈 노트를 작성한다.

업그레이드는 SW HW에 대한 항목까지 포함된다.

사용자 요청에 따른 특이한 케이스 발생

제품 소프트웨어가 사용자에 배포됨에 따라 기존에 배포된 릴리즈 노트의 연락처 정보를 통해 사용자의 의견이 접수된 경우이다. 개발 팀 내부에서 허용되는 범위 내에서 요청이 접수될 경우 이를 자체 기능 향상과는 별도의 버전으로 새로 추가하여 릴리즈 노트를 작성할 수 있다.

 

 


반응형