제품의 새로운 버전이 출시됐다면 사용자들에게 어떤 기능이 추가되고 무엇이 개선되었고 어떤 버그가 해결됐는지를 체계적으로 전달하면 고객들은 잘 관리되고 있는 제품이라고 생각할 것입니다.
이번 강의에서는 Jira 에서 제공하는 버전과 릴리스 관리 기능을 활용해서 제품이나 서비스의 릴리스 노트를 만드는 법에 대해서 학습하겠습니다.
릴리스 노트는 마케팅 팀이 있다면 PO 와 마케팅 담당자가 같이 작성해야 할 문서입니다.
이런 문서는 Jira 보다는 confluence 가 더 적당하므로 이번 장은 confluence 를 활용해서 진행할 예정이므로 confluence 를 사용하지 않는 분들은 이번장을 건너 뛰시면 됩니다.
JIRA 의 릴리스 노트 기능 사용
먼저 Jira 에서 자동으로 제공하는 기능을 이용해서 릴리스 노트를 만들어 보겠습니다.
차세대 프로젝트는 이 기능을 지원 안 함.
프로젝트 버전 목록에서 "릴리스 됨" 을 선택한 후에 릴리스된 버전을 클릭해서 상세 화면으로 들어갑니다.
여기에서 우측 상단의 "릴리즈 노트"를 클릭하면 HTML 이 생성됩니다.
confluence 에서 사용
생성된 노트가 HTML 이므로 별도의 제품 페이지가 있다면 거기에 입력하고 CSS 등을 조정해서 꾸며도 되고 만약 confluence 를 통해서 제품의 변경 사항을 관리한다면
릴리스노트 페이지를 만들고 confluence 의 html 매크로로 Jira 에서 생성한 릴리스 노트를 넣어주면 됩니다.
그런데 이 방식은 큰 문제는 있는데 html 매크로는 Jira stand alone 에서만 지원하고 cloud 는 이 기능을 지원하지 않습니다. html 을 페이지에 입력할 수 있는 별도의 플러그인이 있지만 상용입니다.
수동 릴리스 노트 페이지 작성
html 미지원 문제가 있고 또 jira 에서 자동 생성된 릴리스 노트는 단순하게 이슈의 나열이라 고객 입장에서는 가독성도 떨어지고 예쁘지도 않아서 이 방식을 잘 사용하지는 않습니다.
제가 추천드리고 싶은 방식은 Atlassian 처럼 릴리스 노트 페이지를 confluence 작성하고 고객이 이해하기 쉽게 주요 변경 사항 목록과 이에 대한 상세 내용,
중요한 환경 변화, 예로 지원하는 DBMS 종류가 변경되었거나 낮은 버전의 JDK 는 지원이 종료되는등의 주요 사항을 적어주는 것입니다.
그리고 마지막에 현재 버전에서 해결한 이슈의 목록을 지라에서 추출해서 confluence 페이지에 연결하는 것입니다.
이제 confleunce 에 샘플로 릴리스 노트를 만들어 보겠습니다.
먼저 상단의 만들기 또는 c 키를 클릭해서 새 페이지를 생성한 후에 제목에 "TODO 1.0 Releases note" 라고 입력합니다.
이제 / 를 눌러서 h4 로 "변경 사항" 이라고 입력합니다.
그리고 / 를 눌러서 목차 매크로를 추가하고 클릭해서 설정에 들어간 후에 최대제목레벨을 7 에서 3으로 변경합니다.
이제 제품의 개선 사항을 적어 보겠습니다.
h3 할일관리 기능, h3 검색 성능 개선, Fh3 해결 이슈 이렇게 크게 3가지 항목을 입력합니다.
이렇게 위는 h4 아래는 h3 로 한 것은 나중에 목차에서 주요 변경 사항을 빼기 위해서입니다.
이제 "할일관리 기능" 하단에 할일관리, 기한 알림 기능 이라고 넣고 "검색 기능 개선"은 "한글 형태소 처리로 검색 정확성 개선"이라고만 넣겠습니다.
위와 같이 주요 변경 사항등을 정리하고 마지막 항목 해결이슈에 jira 에서 만든 버전을 link 해서 해결한 이슈 목록을 연결해 주기 위해서 지라로 들어갑니다.
프로젝트를 선택한 후에 릴리스를 클릭하고 "릴리스 노트" 를 만들 버전을 클릭합니다.
여기에서 "이슈 완료" 를 클릭하면 처리한 이슈의 목록이 나오는데 우측 끝에 "이슈 탐색기에서 보기" 를 클릭합니다.
그러면 이슈 검색 창이 뜨고 버전을 추출하기 위한 화면이 뜨는데 상단의 "다른 이름으로 저장" 을 클릭한 후에 필터 저장에 필터 이름을 "proj-ver1" 으로 입력하고 제출을 클릭합니다.
이런 검색 구문을 JQL 이라 하는데 "필터와 검색" 에서 학습하겠습니다.
그후에 / Jira 를 선택해서 검색 항목에 filter="proj-ver1" 을 입력한 후에 검색 버튼을 클릭해서 이슈 목록이 정상적으로 뜨는지 확인합니다.
그리고 확인을 누른후에 페이지를 저장하면 수동 '릴리스 노트' 페이지 작성이 완료되었습니다.
만약 해결한 이슈 항목에 보이는 게 필드가 너무 많다면 지라 이슈 항목에서 편집을 누르고 들어가서 하단의 표시옵션을 클릭한 후에 "표시할 열" 에서 불필요한 부분을 제거하면 됩니다.
만약 현재 버전에 이슈가 많다면 새기능, 개선등을 하나로 묶고 버그만 별도 항목으로 나눠서 관리할수도 있습니다.