본문 바로가기

테크니컬 라이팅/WTD 컨퍼런스

WTD 포틀랜드 2023 - 문서를 코드처럼 관리하는 건 항상 쉬운 건 아닙니다

반응형

이번 강연은 대충 어떤 이야기인지는 알겠는데 정리가 안되더라구요 ㅠㅠ 그래서 "YouTube & Article Summary powered by ChatGPT"라는 플러그인을 사용해 내용을 요약해 보았습니다. 무서운 세상이네요.

 

  • 콘텐츠 관리 시스템(CMS)에서 문서를 코드처럼 관리하기로 전환하는 것이 쉽지 않다는 것을 공감합니다.
  • 성공적으로 문서를 코드처럼 관리할 수 있게 하려면 그들을 응원하고 적절한 지침을 제공하는 것이 필요합니다.
  • 문서를 코드처럼 관리하는 장점은 협업, 미리 보기, 통합 워크플로우 등을 이야기할 수 있습니다(물론 요즘 CMS 또는 매뉴얼 저작 도구에서도 이런 것들은 지원하고 있긴 합니다).
  • 조직 내에서 문서를 코드처럼 관리하기로 전환하기 위해 적합성을 평가하고 어느 정도의 비용이 들어갈 지 추정하는 방법을 설명합니다.
  • 조직 내 의사결정자를 설득하기 위해 자료를 준비하고 또한 자신과 팀을 어떻게 설득해야 할지 설명합니다.

 

일단 공감되는 부분은 개발 조직 내에서는 문서를 코드처럼 관리하는 것이 그리 어렵지 않습니다. 이미 코드 개발을 위한 프로세스가 존재하고(물론 그렇지 않은 곳도 있긴 합니다) 문서화 프로세스를 만들기 위해 도와줄 개발자들도 많으니깐요. 좀 더 여유가 있는 조직이라면 문서팀에 전담 개발자가 배정되기도 하구요.

이번 강연에서 이야기하는 것은 그렇지 않은 조직입니다. 주변에 개발자도 없고 Git이 뭔지 아는 직원도 없는 경우라는 것이지요. 어떻게 시작을 해야 할지 막막한 상황에 대한 이야기입니다.

 

 

그냥 뭐 관련 영상이나 책을 보고 시작해 보라고 할 수도 있겠지만 규모가 큰 경우에는 도전하는 것 자체가 쉬운 일이 아닙니다. 생각보다 넘어야 할 산이 많다는 거죠. 그래서 이들을 도울 수 있는 공개 워크숍도 진행하고 단계별로 참고할 수 있는 자료도 필요하다는 겁니다.

 

https://youtu.be/E12mXHjcQBE

 

 

 

728x90