Kjerr따라 쓸 만한
체인지로그 예시.
좋은 체인지로그 예시에는 세 가지 공통점이 있습니다. 무엇이 바뀌었는지 말하는 제목, 사용자가 이제 무엇을 할 수 있는지에 관한 문장, 그리고 다음에 무엇을 해야 하는지에 대한 정직한 안내. 아래에 변경 유형마다 하나씩 네 개의 글, 그다음 체인지로그와 릴리스 노트의 차이와 체크리스트가 있습니다.
카테고리별 체인지로그 예시 네 가지
각 예시는 가상의 제품을 위해, Kjerr의 공지사항 섹션이 쓰는 네 카테고리로 썼습니다. 단어가 아니라 형태를 가져가세요.
새 기능
2단계 인증이 추가되었습니다
이제 로그인에 두 번째 단계를 더해 계정을 보호할 수 있습니다. 설정, 보안으로 가서 아무 인증 앱으로 QR 코드를 스캔하고 백업 코드를 저장하세요. 워크스페이스 소유자는 모든 팀원에게 이것을 요구할 수 있습니다. 저희 보드에서 가장 많이 요청된 항목 중 하나였습니다.
효과가 있는 이유: 사용자가 이제 할 수 있는 것으로 시작하고, 어디서 찾는지 말하고, 요청에 감사합니다.
개선
리포트가 최대 3배 빨라졌습니다
리포트를 계산하는 방식을 다시 만들었습니다. 큰 계정에서 6초 걸리던 월간 요약이 이제 2초 안에 열리고, 1년을 넘는 날짜 범위도 더 이상 멈추지 않습니다. 숫자 자체는 바뀌지 않았습니다.
효과가 있는 이유: 읽는 사람이 체감할 숫자를 주고, 데이터는 같다고 안심시킵니다.
수정
수정: CSV 내보내기에서 마지막 행이 빠졌습니다
10,000행을 넘는 내보내기에서 마지막 행이 빠졌습니다. 버그는 수정되었고 오늘부터 실행한 내보내기는 완전합니다. 8월 상반기에 큰 리포트를 내보냈다면 다시 실행해 주세요.
효과가 있는 이유: 무엇이 잘못됐고, 누가 영향을 받았고, 무엇을 해야 하는지 말합니다. 에둘러 말하지 않습니다.
공지
이번 가을에 작업하는 것들
여러분의 투표를 바탕으로 다음 몇 달을 짧게 미리 봅니다. Slack 알림은 개발 중입니다. 다음은 다크 모드입니다. 보드에서 가장 많은 표를 받은 아이디어이고 디자인이 시작되었습니다. 각각 출시되면 여기에 쓰겠습니다.
효과가 있는 이유: 지킬 수 없는 날짜 없이 기대치를 정하고, 투표를 가리킵니다.
효과 있는 체인지로그 글의 구조
- 제목: 버전 번호가 아니라 변경. “리포트가 최대 3배 빨라졌습니다”는 읽는 사람에게 자기 일인지 말해 줍니다. “v4.12.1”은 말해 주지 않습니다.
- 카테고리. 새 기능, 개선, 수정, 공지. 둘러보고 걸러 볼 수 있게 합니다.
- 이제 무엇을 할 수 있는지. 사용자 관점에서 한두 문장.
- 어디서 찾는지. 메뉴 경로나 링크.
- 다음에 할 일. 대개 없습니다. 수정 때문에 다시 내보내거나 설정을 바꿔야 한다면 분명히 말하세요.
- 요청에 감사하기. 사용자가 요청한 것이라면 요청을 링크하세요. 피드백을 읽는다는 가장 저렴한 증거입니다.
체인지로그와 릴리스 노트의 차이
체인지로그는 의미 있는 모든 변경의 연속된 기록이고, 릴리스 노트는 하나의 릴리스에 대한 설명입니다. 체인지로그는 훑어보는 목록입니다. 짧은 글, 최신순, 변경마다 하나. 릴리스 노트는 읽는 문서입니다. 한 버전의 변경을 묶고, 큰 것은 스크린샷으로 설명하고, 업그레이드나 마이그레이션 단계를 담습니다.
작은 팀에는 보통 체인지로그만으로 충분하고, 릴리스가 그럴 가치가 있을 때 긴 글을 하나 쓰면 됩니다. 버전이 있는 설치형 제품이나 API가 있는 제품은 릴리스 노트도 함께 내고 체인지로그의 각 글에서 링크하는 일이 많습니다.
게시 전 체크리스트
여러분의 로드맵을 한 번도 본 적 없는 사용자처럼 글을 읽어 보세요.
- 제목만 봐도 이해되나요?
- 첫 문장이 팀이 아니라 사용자에 관한 것인가요?
- 도움이 될 자리에 숫자, 경로, 스크린샷이 있나요?
- 무언가 고장 났었다면, 누가 영향을 받았고 무엇을 해야 하는지 분명한가요?
- 이 글이 답하는 요청이 링크되어 있나요?
- 우연히 들여다본 사람뿐 아니라 요청한 사람이 이 글을 알게 되나요?
Kjerr에서 이런 글을 게시하는 방법
Kjerr의 공지사항 섹션은 위의 네 카테고리를 가진 체인지로그입니다. 글은 제목, 목록, 링크, 이미지를 지원하고, 자기가 답하는 아이디어를 가리키며, 게시할 때 구독자에게 이메일을 보낼 수 있습니다.
- 카테고리, 본문과 날짜 검색, 이모지 반응, 댓글.
- 이메일 인증을 거친 구독.
- 연결된 아이디어가 글 아래에 보입니다. Shipped 상태가 투표자에게 이메일을 보냅니다.
- 여러분의 사이트에 놓은 위젯이 같은 공지를 사이드 패널에 보여주고, 버튼에 읽지 않은 글 수가 표시됩니다.
자주 묻는 질문과 간단한 답.
체인지로그란 무엇인가요?
체인지로그는 제품 변경 사항을 최신순으로 적은 날짜 있는 목록으로, 제품을 쓰는 사람을 위해 씁니다. 각 글은 무엇이 바뀌었고, 누구에게 영향이 있고, 해야 할 일이 있다면 무엇인지 말합니다.
체인지로그와 릴리스 노트는 무엇이 다른가요?
체인지로그는 의미 있는 모든 변경의 연속된 기록이고, 릴리스 노트는 하나의 릴리스에 대한 설명입니다. 체인지로그 글은 몇 문장입니다. 릴리스 노트는 스크린샷과 업그레이드 단계가 들어가 한 페이지가 될 수 있습니다. 많은 제품이 둘을 같은 자리에 게시합니다.
체인지로그 글에는 무엇이 들어가야 하나요?
무엇이 바뀌었는지 말하는 제목, 카테고리, 사용자가 이제 무엇을 할 수 있는지에 관한 한두 문장, 어디서 찾는지, 그리고 필요한 조치가 있다면 그것. 변경이 요청에 대한 답이라면 그렇다고 말하고 링크하세요.
체인지로그는 얼마나 자주 갱신해야 하나요?
사용자가 알아볼 수 있는 것을 출시할 때마다. 한두 주마다의 짧은 글이 분기마다의 긴 글보다 더 많은 신뢰를 쌓습니다.
체인지로그는 어디에 있어야 하나요?
링크하고, 검색하고, 색인할 수 있도록 자기 주소가 있는 공개 페이지에, 그리고 구독자를 위한 이메일에. Kjerr는 체인지로그를 기능 요청과 같은 보드에 둡니다.
관련 페이지
사용자에게 답을 돌려주세요.
얼리 액세스 기간 동안 Kjerr는 무료입니다. 모든 기능이 포함되고 신용카드는 필요 없습니다. 유료 요금제가 나오면 워크스페이스 단위로 책정되며, 관리자 시트당 과금은 하지 않습니다.