본문 바로가기
SSAFY/SSAFYcial

[SSAFYcial] 릴리즈 노트, 이렇게 작성해요!

by sun_HY 2023. 1. 13.

[SSAFYcial] 10월 자율기사

릴리즈 노트, 이렇게 작성해요!

'릴리즈 노트'란?

서비스를 배포할 때 함께 배포하는 문서를 말해요.

개발 과정에 대한 내용이나 새로운 개선 사항,

소프트웨어를 이용할 때 참고하면 좋은 내용들을 포함합니다.

사용자에게 서비스에 대한 정보를 제공하는 역할을 해요.

어떤 것을 주의해서 작성해야 하나요?

1. 표준 형식은 존재하지 않아요!

자신의 서비스에 맞는 양식을 채택해요.

2. 변경 사항이 사용자에게 가져올 영향을 정확히 전달해요.

3. 사용자가 이해하기 어려운 전문용어만 사용하지 않도록 주의해요.

이런 태그를 주로 사용해요!

New 새로운 서비스나 문서를 추가했어요.

Feature 새로운 기능이 추가되었어요.

Fixed 오류나 버그가 수정되었어요.

Changed 기존의 기능이 변경되었어요.

참고하면 좋은 예시

아직 릴리즈 노트가 무엇인지 감이 잡히지 않으신다면,

이런 다양한 예시를 참고해보세요!

(이 게시물은 카카오 기술 문서를 참고하여 작성했어요)

NHN Cloud 릴리즈 노트

넷플릭스 릴리즈 노트

카카오 워크 릴리즈 노트

 


728x90