문서화에서 '릴리스 레디'라는 표현은 제품 릴리스 후 24시간 내에 모든 문서와 번역이 완벽하게 완료될 수 있다는 것을 의미합니다. 어찌보면 당연한 거 아닌가 싶기도 한데 제품과 문서가 같은 프로세스를 따라 배포되지 않는다면 문제가 되는 부분이라는 것을 알 수 있습니다. 문서를 코드처럼 다루기랑 비슷한 주제죠. 그래서 이번 발표에서는 안정된 프로세스가 없더라도 '릴리스 레디' 문서 프로세스를 만들 수 있는 팁을 제시합니다.
(1) 뭐가 바뀌는지 알기
- 제품팀과 긴밀한 관계를 가지고 계속 커뮤니케이션하는 것이 중요합니다.
궁금한 것은 바로 물어볼 수 있어야 하고 어느 정도의 가시성(신규 개발 일정)을 확보해야 합니다.
(2) 규모 확인하기
- 릴리스마다 항상 같은 비중으로 문서가 작성되는 것은 아닙니다. 어느 때는 적을 수 있고 어느 때는 많을 수 있습니다.
그래서 릴리스 규모를 확인하고 어느 시점부터 대응해야 하는지 확인해야 합니다.
(3) 초안 작성하기
- 초안은 텍스트로 작성하고 피드백을 받으면서 보완합니다.
화면 이미지는 스테이징 환경에서 확인합니다(가능하다면). 그리고 화면 이미지에 다른 기능이 포함되거나 특정 날짜가 포함되지 않도록 주의합니다(날짜가 포함되어야 한다면 아예 2-3년 뒤의 날짜를 설정하거나 아니면 크롬 개발자 도구에서 년도를 변경해 이미지를 캡쳐하세요).
(4) 릴리스
- 제품팀에서 릴리스를 공개하면 준비된 문서를 공개합니다.
중요한 내용은 What's new 같은 형식으로 공개할 수 있습니다.
(2)번 규모 확인 시 정말 큰 건인 경우에는 중요도에 따라 콘텐츠를 나누고 그에 따라 일정을 조정합니다.
어느 정도 합의를 보는 거죠.
중요도는 사용자가 자주 사용하는 기능인가(트래픽이 높은 페이지인지) 등을 기준으로 합니다.
