기술 문서 배포를 위한 프로세스

🐾들어가며

Docs for Developers 의 chapter 7 문서 배포하기를 읽고 예시를 찾아보면서 같이 정리했습니다.

이번 챕터에서는 문서를 배포하기 위한 프로세스를 만드는 것을 목표로 합니다.

✨본격적으로

✅문서 배포

문서 배포: 사용자가 콘텐츠를 읽고 따라할 수 있도록 하는 것을 의미하며, 소프트웨어가 릴리스되었음을 알리는 것과 유사하다.

완벽한 문서는 거의 없다. 문서 배포에 대한 두려움을 다루는 가장 좋은 방법은 배포 후에 피드백을 기반으로 그동안 했던 과정을 반복하는 것이다.

해당 챕터는 다음과 같은 내용으로 구성되어 있으나, 프로세스 구축과 타임라인 만들기를 위주로 내용을 정리하였습니다.

• 콘텐츠 릴리스 프로세스 구축하기
• 배포 타임라인 만들기
• 배포 확정 및 승인하기
• 독자에게 콘텐츠 알리기

✅콘텐츠 릴리스 프로세스

프로세스를 만들기 전에 질문하기

• 콘텐츠를 언제 배포할 것인가?
• 최정 검토와 배포는 누가 담당하는가?
• 콘텐츠를 어디에 배포할 것인가?
• 콘텐츠를 배포하려면 어떤 소프트웨어 도구가 추가로 필요한가?
• 새로운 콘텐츠를 사용자에게 어떻게 알릴 것인가?

중요한 점은 독자에게 콘텐츠를 전달하기 위한 방안을 마련한다는 것이다.

✅배포 타임라인

모든 문서 릴리스에 대해 배포 타임라인을 설정하자. 소규모 릴리스라도 다른 사람의 참여가 어느 정도 필요하다.

• 문서 배포 일정은 제품 릴리스 일정과 맞춰야 한다.
• 릴리스에 대한 책임을 지는 담당자를 지정해야 한다.
• 코드 리뷰 프로세스를 이용해 배포 절차의 일관성을 보장하자.
• 자체 기준을 정하고 그 기준을 충실히 지키자.
• 사용자가 있는 곳에서 콘텐츠와 만나게 해라.
• 문서를 위한 또다른 문서화가 필요하며, 적어도 문서를 릴리스하는 프로세스는 문서화해야 한다.
• 새로운 자료가 나왔음을 독자에게 알려야 한다.
• 문서화에서 발생할 수 있는 문제 등 앞날을 위해 준비해야 한다.

✔️결론

문서에도 배포라는 개념이 쓰일지는 몰랐는데, 이번 챕터에서 문서를 배포하는 프로세스를 보니, 그동안 문서화 과정이 언제 이루어져야 하는지는 신경쓰지 않고 있던 것 같습니다. 문서를 위한 문서화를 해서 관리한다는 것도 좋은 것 같습니다. 또한, 열심히 작성한 문서를 독자에게 보여주기 위해 어디에서 링크를 걸어야 하는지도 잘 나와있어서 참고가 잘 된 것 같습니다.

이 글은 옵시디언을 통해 발행하였습니다.