릴리스 노트

Release notes

릴리스 노트는 소프트웨어 제품 또는 하드웨어 제품과 함께 배포되는 문서로, 때때로 제품이 아직 개발 또는 테스트 상태일 때(예: 베타 릴리스)에 있을 때도 있다.[1][2]고객이 이미 사용 중인 제품의 경우 업데이트가 출시되면 릴리즈 노트가 고객에게 전달된다.Release notes의 또 다른 약어는 Changelog 또는 Release logs 또는 Software changes 또는 Revision history Updates 또는 README 파일이다.[3]단, Release notes와 Changelog가 별도로 발행되는 경우도 있다.이 분할은 버그로부터의 특징 강조 표시, 변경 요청(CR) 또는 다른 쪽의 개선 사항의 명확성과 차별화를 위한 것이다.[4][5]

목적.

릴리스 노트는 조직의 최종 사용자, 고객 및 고객과 공유되는 문서다.'최종 사용자', '고객' 및 '고객' 용어의 정의는 본질적으로 매우 상대적이며 구체적인 맥락에 따라 다양한 해석을 할 수 있다.예를 들어, 소프트웨어 개발 조직 내의 품질 보증 그룹은 내부 고객으로 해석될 수 있다.[6]

내용

릴리스 노트에는 회사가 제공하는 서비스 또는 제품에 대한 수정, 변경 또는 개선 사항(기능 또는 비기능)이 자세히 설명되어 있다.[7][8][9]

그것들은 또한 시스템 시험 및 시스템 통합 시험의 결과물 및 기타 관리 환경에 수반되는 인공물로 제공될 수 있다. 특히 정보 기술 기관을 참조한다.

릴리스 노트에는 테스트 결과 및 테스트 절차에 대한 정보도 포함될 수 있다.이러한 종류의 정보는 발행어음 독자에게 수정/변경에 대한 더 많은 신뢰를 준다. 또한 이러한 정보는 변경의 시행자가 기본적인 인수 시험을 실시할 수 있게 한다.

이들은 소프트웨어 제품 또는 서비스의 법적 조건을 포함하지 않기 때문에 최종 사용자 라이센스 계약과 다르다.예를 들어 법적 조건이 아니라 소프트웨어 릴리스 자체에 초점을 맞춰야 한다.[10]

릴리스 노트는 새로운 기능이나 해결된 버그를 강조하지 않고 소프트웨어를 설치하거나 구축하는 방법을 설명하는 것으로도 해석할 수 있다.[11]이 맥락에서 자주 사용되는 또 다른 용어는 소프트웨어를 설치하거나 구축하는 데 필요한 하드웨어와 소프트웨어를 의미하는 시스템 요구사항이다.

형식 스타일

다른 조직 전체에 걸쳐 뒤따르는 릴리스 노트에 대한 표준 형식은 없다.조직은 일반적으로 유통되는 정보의 요구사항과 유형에 따라 자체 포맷 방식을 채택한다.릴리스 노트의 내용도 릴리스 유형에 따라 다르다.테스트 단계에 있으며 새로 출시된 제품의 경우 일반적으로 간략한 버그 수정 및 기능 향상을 위한 릴리스 노트에 비해 내용이 더 설명적이다.

릴리스 노트에는 다음 섹션이 포함될 수 있다.

  • 헤더 – 문서 이름(예: 릴리스 노트), 제품 이름, 릴리스 번호, 릴리스 날짜, 노트 날짜, 노트 버전 등
  • 개요 - 공식 문서가 없는 경우 제품 및 변경 사항에 대한 간략한 개요.
  • 목적 - 버그 수정 및 새 기능을 포함한 이 릴리스의 새로운 기능에 대한 목록과 함께 릴리스 노트의 목적에 대한 간략한 개요.
  • 문제 요약 - 버그 또는 릴리스의 향상에 대한 간략한 설명.
  • 재생산 단계 - 버그를 만났을 때 수행된 단계.
  • 해결책 - 버그를 수정하기 위해 수행한 수정/강화에 대한 간략한 설명.
  • 최종 사용자 영향 - 응용프로그램의 최종 사용자에게 필요한 다른 작업여기에는 이러한 변경사항의 영향을 받는 다른 기능이 포함되어야 한다.
  • 지원 영향 - 소프트웨어 관리 일상적인 프로세스에 필요한 변경 사항.
  • 참고 - 소프트웨어 또는 하드웨어 설치, 업그레이드 및 제품 설명서(문서 업데이트 포함)에 대한 참고 사항
  • 고지 사항 - 회사 및 표준 제품 관련 메시지(예: 프리웨어, 해적 방지, 복제 등)거부권을 참조하십시오.
  • 연락처 - 지원 연락처 정보

릴리스 노트는 일반적으로 특정 소프트웨어 릴리스의 최근 변경사항, 개선사항 및 버그 수정에 대한 간결한 요약이다.그것은 사용자 안내를 대신하는 것이 아니다.릴리스 노트는 현재 시제로 자주 작성되며 명확하고 정확하며 완전한 정보를 제공한다.

공개 지정에 대한 제안이 존재하며, 이를 릴리스 노트 스키마 사양이라고 한다.[12]

대표적인 예(주로 소프트웨어)

다음 목록은 소프트웨어 게임, 운영 체제, 자동차, CAD 설계 등 각 지점의 주요 소프트웨어를 선별한 것이다.

참고 항목

추가 읽기

  • 로라 모레노 외ARENA: 소프트웨어 엔지니어링에 대한 릴리즈 노트 자동 생성, IEEE 트랜잭션을 위한 접근방식 (권: 43, 발행: 2017년 2월 1일)[14]
  • 케이시 뉴턴나는 맥주를 마시고 미디엄 릴리즈 노트팀 더 버지(2016-02-10)[15]와 릴리즈 노트를 작성했다.
  • GNU 코딩 표준 - 6.8 변경 로그

참조

  1. ^ "Change Log Concepts (GNU Coding Standards)". www.gnu.org. Retrieved 2021-04-05.
  2. ^ Scott, James (2020-04-24). "The art of writing great release notes". Medium. Retrieved 2021-04-05.
  3. ^ "Releases (GNU Coding Standards)". www.gnu.org. Retrieved 2021-04-05.
  4. ^ "Version History - English - Knowledge Base". kb.i-doit.com. Retrieved 2021-10-10.
  5. ^ "56508 - Zynq-7000 SoC, 14.6 FSBL - Is there a changelog?". Xilinx Support Keyword Search.{{cite web}}: CS1 maint : url-status (링크)
  6. ^ Hobbs, Brian; Besner, Claude (2016-05-01). "Projects with internal vs. external customers: An empirical investigation of variation in practice". International Journal of Project Management. 34 (4): 675–687. doi:10.1016/j.ijproman.2016.02.010. ISSN 0263-7863.
  7. ^ "Change Logs (GNU Coding Standards)". www.gnu.org. Retrieved 2021-04-05.
  8. ^ Wang, C.; Li, J.; Liang, P.; Daneva, M.; Sinderen, M. (September 2019). "Developers' Eyes on the Changes of Apps: An Exploratory Study on App Changelogs". 2019 IEEE 27th International Requirements Engineering Conference Workshops (REW): 207–212. doi:10.1109/REW.2019.00042. ISBN 978-1-7281-5165-6. S2CID 209460408.
  9. ^ Bourne, Kelly C. (2014-01-01), Bourne, Kelly C. (ed.), "Chapter 10 - Updates and Patches", Application Administrators Handbook, Boston: Morgan Kaufmann, pp. 150–165, doi:10.1016/b978-0-12-398545-3.00010-8, ISBN 978-0-12-398545-3, retrieved 2021-03-25
  10. ^ release-notes/release-notes-spec, Release Notes, 2021-03-25, retrieved 2021-03-25
  11. ^ "Linux kernel release 5.x — The Linux Kernel documentation". www.kernel.org. Retrieved 2021-03-25.
  12. ^ release-notes/release-notes-spec, Release Notes, 2021-03-25, retrieved 2021-03-25
  13. ^ "Releases · GitLab.org / GitLab". GitLab. Retrieved 2021-02-13.
  14. ^ Moreno, L.; Bavota, G.; Penta, M. D.; Oliveto, R.; Marcus, A.; Canfora, G. (February 2017). "ARENA: An Approach for the Automated Generation of Release Notes". IEEE Transactions on Software Engineering. 43 (2): 106–127. doi:10.1109/TSE.2016.2591536. ISSN 1939-3520.
  15. ^ Newton, Casey (2016-02-10). "I drank beer and wrote release notes with the Medium release notes team". The Verge. Retrieved 2021-04-05.

외부 링크