릴리스 노트 작성 우수 사례

모든 버전의 소프트웨어를 제공 할 때 릴리스 노트를 작성해야합니다. 예를 들어 릴리스 노트를 작성할 때 추가하는 용어는 다음과 같습니다.

출시일
버그 해결

이것으로 충분합니까 아니면 다른 것이 있습니까?

release

— CoolProgrammer
소스

의 중복 등이 보이는 programmers.stackexchange.com/questions/66377/...

추가 된 기능을 잊지 마십시오

— 래칫 괴물 8

답변:

다음은 좋은 습관을 길러 줄 것이라고 생각합니다.

// 날짜 관련

출시일

// 기능 관련

추가 된 기능
추천 제거
변경된 기능

// 버그 관련

해결 된 버그
해결되지 않은 버그

// 의존성 관련

의존성 목록

// 테스트 관련

단위 테스트 결과
합격 시험 결과

// 버전 관리 관련

태그 노트
개정 번호

또한 최종 사용자가 구성 또는 워크 플로에서 변경하고자하는 사항을 강조 할 가치가있는 경우도 있습니다.

대부분의 최종 사용자는 테스트 결과에 신경 쓰지 않습니다. 릴리스 노트의 내용에 관계없이 고품질을 기대합니다.

릴리즈 노트에서 가장 중요한 점은 모든 추가 문장이 독자의 10 %를 잃는다는 것을 인식하는 것입니다. 따라서 현재 사용자가 릴리스에 대해 알아야 할 사항을 엄격하게 우선시해야합니다.

— Md Mahbubur Rahman
소스

최종 사용자가 자신의 구성이나 워크 플로우에서 변경할 수 있습니다 것을 강조의 일부 시간 가치

— JK합니다.

@jk. 그래 당신 말이 맞아요. 나는 당신의 좋은 의견으로 답변을 편집했습니다.

— Md Mahbubur Rahman 8

대부분의 최종 사용자는 테스트 결과에 신경 쓰지 않습니다. 릴리스 노트의 내용에 관계없이 고품질을 기대합니다.

— Henrik

@Henrik 릴리스 노트는 최종 사용자 이외의 사람들에게 유용 할 수 있습니다

— jk.

릴리즈 노트에서 가장 중요한 점은 모든 추가 문장이 독자의 10 %를 잃는다는 것을 인식하는 것입니다. 따라서 현재 사용자가 릴리스에 대해 알아야 할 사항을 엄격하게 우선시해야합니다.

— ddyer
소스

각 라인은 캐주얼하고 관심이없는 (또는 게으른) 독자의 10 %를 잃을 수 있습니다. 해당 독자는 릴리스 정보를 작성하지 않은 독자입니다. 당신이 한 일에 관심이있는 사람들은 모든 것을 읽고 각 관련 라인에 대해 감사합니다. 문서에 올바르게 들어가야하는 보풀을 포함시키는 것에 대해서만주의해야합니다.

— gbjbaanb