의사소통 문서타입 - 릴리즈노트

ChatGPT로 효율적 영어쓰기

by AI개발자

Dec 12. 2024

제품이나 서비스가 출시되었을 때, 변경된 부분이나 새로운 기능등의 정보를 정리한 문사거 릴리즈노트(Release Note)입니다. 리스트를 사용하여 간단히 기록하는 형태가 일반적입니다.

⑴ 릴리즈노트 예시

릴리즈노트의 예시를 살펴보겠습니다. 앞에서 설명했던 웹애플리케이션 "Simple Sales Meeting"의 릴리즈노트입니다.

☞ 참고 번역

릴리즈노트

2023년 9월 14일

신기능

음성에서 텍스트로의 변환 AI를 사용하여 대화를 텍스트로 변환할 수 있게 되었습니다.

클라우드 스토리지에서의 비디오 공유 Google Drive, OneDrive 그리고 Dropbox에 비디오 파일을 내보내고 공유할 수 있게 되었습니다.

수정사항

5명이상의 사용자가 대화에 참여했을 때 프로필 사진이 표시되지 않는 문제를 수정. 문제번호 10123

대회기록이 자동으로 업데이트되지 않는 문제를 수정. 문제번호 10117

2023년 7월 20일

변경사항

신규 계정 생성시 비밀번호에 필요한 최소문자수를 변경.

기존문제

5명 이상의 사용자가 대화에 참여했을 떄 프로필 사진이 표시되지 않음. 문제번호 10123 회피책: 설정에서 프로필 사진 표시를 끔으로 변경함

2023년 5월 18일

개선사항

UI 표시 언어로 간체자 중국어와 번체자 중국어를 추가

비디오 저장 완료까지 걸리는 시간을 단축.

수정사항

대화명에 아랍어 문자를 입력하면 표시되지 않는 문제를 수정. 문제번호 10087

미리보기 표시 실패가 간헐적으로 발생하는 원인이 된 문제를 수정 문제번호 10061

⑵ 문서의 주요요소와 구성

다음으로 문서의 주요 요소와 구성을 확인합니다.

▷ 제목 (①)

한번의 릴리즈노트 전체를 아우르는 제목입니다. 일반적으로 "버전번호"나 "날짜"가 사용됩니다. 예를 들어, 웹 애플리케이션에서는 날짜만 기록되는 경우도 있으며, 설치형 애플리케이션에서는 두 항목이 모두 기록됩니다.

①에 표시된 것처럼 "2023년 9월 14"의 날짜만 기록되어 있습니다. 독자가 최신 정보를 확인할 수 있도록 새로운 릴리즈노트가 위쪽에 추가됩니다. 참고로 예시 상단에 있는 페이지명은 "Release Note"로 복수형으로 표기되어 있습니다. 일반적으로 영어에서는 복수형으로 사용되는 점에 유의해야 합니다.

▷ 카테고리별 강조표시 (②, ⑤, ⑦, ⑨, ⑪)

한번의 릴리즈노트에는 다양한 정보가 포함됩니다. 따라서 독자가 정보를 더 쉽게 파악할 수 있도록 카테고리별로 강조표시를 추가하여 정보를 정리합니다.

예시를 보면, 다음과 같은 카테고리의 강조표시가 붙어 있습니다.

신기능 (②)

수정사항 (⑤) : 수정된 문제 또는 버그ID (Issue #10123등)을 기록합니다.

변경사항(⑦)

기존문제(⑨): 해당 릴리즈에서 수정되지 않았지만, 존재를 파악하고 있는 문제에 대해 기록하고 문제나 버그ID 및 회피책이 있다면 함께 기록하는 경우도 있습니다.

개선사항(⑪)

예시에는 포함되지 않았지만 다음 강조 표시도 사용됩니다.

비추천된 항목 (Deprecations)

이와 같은 카테고리별 강조 표시명은 릴리즈노트마다 변하지 않도록, 될 수 있으면 일관되게 사용합니다.

예를 들어, 위 예시에서 "수정사항"은 "Fixes"라는 표현이 일관되게 사용되고 있습니다. 수정사항을 나타내는 강조표시로는 다른 표현, 예를 들어, "Bug fixes"나 "Resolved issues"와 같은 단어도 고려될 수 있습니다. 하지만 릴리즈마다 강조표시명이 바뀌면 독자가 혼란스러워질 우려가 있습니다. 조직 및 프로젝트에 따라서는 미리 태그("FIX", "FEATURE" 등)를 준비해 각 항목의 앞에 붙이는 사례도 있습니다.

▷ 주요 요소와 구성

릴리즈노트 1회분의 주요요소와 구성은 아래와 같이 정리합니다. 제목은 필수이지만, 카테고리별 강조표시명은 모든 릴리즈에 반드시 등장하지 않아도 되는 선택사항입니다. 순서는 반드시 고정되지 않습니다.

카테고리별 강조표시로 대표적인 항목 7가지를 제시하고 있지만, 상황에 따라 이 외의 항목을 사용해도 문제가 없습니다. 또한 소규모 릴리즈의 경우에는 카테고리별 강조표시를 넣지 않는 경우도 있습니다.

제목

신기능(선택사항)

개선사항(선택사항)

수정사항(선택사항)

변경사항(선택사항)

기존문제(선택사항)

비추천된항목(선택사항)

구조를 도식화하면 아래 그림과 같습니다.

⑶ 표현의 포인트

계속해서 표현의 포인트입니다.

▷ 리스트를 적극 활용하기

릴리즈노트는 변경사항이나 신기능 등을 정리한 문서입니다. 독자가 필요한 정보를 빠르게 찾을 수 있도록 리스트가 많이 활용됩니다. 예시의 ③은 "Speech-to-text conversion"으로 리스트항목에는 명사형 표현이 사용되었습니다. 그 하위레벨 항목인 ④는 "You can now convert your conversations into text using AI."라는 완전한 문장이 사용되었습니다. 또한 ⑥에서는 "Fixed an issue where conversation history was not automatically updated."와 같이 주어를 생략한 문장이 사용되었습니다. 이처럼 리스트 항목은 문장이어도 되고, 문장이 아닌 명사구등이어도 문제는 없습니다. 그러나, 리스트 내의 레벨이 동일한 경우에는 표현을 통일하는 것이 좋습니다. 통일되어 있지 않으면 독자는 정보를 찾기가 어려워집니다.

▷ 주어를 생략하고 동사부터 작성하기

위에서 설명한 것철험, 문장의 주어를 생략하고 동사부터 시작하는 작성방식이 자주 보입니다. 예를 들어, ⑥의 "Fixed an issue where..."나 ⑧의 "Changed the minimum number of..."등이 있습니다. 주어 생략은 API참조문서나 주석등에서도 보이며, "Adds a table ..."와 같이 3인칭 단수 현재형이 사용됩니다.

한편 릴리즈노트에서는 "Fixed an issue where ..."나 "Changed the minimum number of ... "처럼 과거형이 사용되는 것이 일반적입니다. 이는 이미 수정된 문제점이나 변경된 사항에 대해 설명하기 위해서입니다.

⑷ 중요한 단어와 표현집

마지막으로 중요한 단어와 표현을 정리합니다.

▷ 강조 표시의 단어들

앞서 "문서의 주요요소와 구성"에서 카테고리별 대표적인 강조표시를 6가지로 정리했습니다. 각 강조표시에 대해 일반적으로 사용되는 영어표현을 몇가지 소개합니다.

▷ 릴리즈 항목의 첫머리 동사

릴리즈 항목에서는 주어를 생략하고 동사로 시작하는 작성방식이 많이 사용됩니다. 예를 들어 예시의 ⑥이나 ⑧등이 있습니다. 첫머리는 각 항목에서 사용자가 가장 먼저 주목하는 부분이므로, 내용을 적절히 표현할 단어를 선택하는 것이 중요합니다. 첫머리에 사용되는 동사 중 자주 등장하는 10가지에 대해 설명합니다.

소규모 릴리즈노트에서는 카테고리별 강조표시를 붙이지 않는 경우가 있습니다. 이 경우, 독자가 릴리즈 내용을 빠르게 파악할 수 있도록 동사를 첫머리에 배치하는 것이 중요합니다. 예를 들어, 문제를 수정한 것이라면 fixed나 resolved를 사용하면 이해하기 쉽습니다.