사내 문서화 개선 프로젝트 노하우

커머스 사이트 구축 B2B SaaS를 제공하는 메두사(Medusa)가 사내 문서화 개선 프로젝트 노하우를 블로그에 공개했어요. 아무래도 기업 고객과 협업할 일이 많다보니 전반적으로 콘텐츠, 디자인, 과거 수집된 피드백과 반영 현황 등을 잘 정리해서 공유해야 할 텐데요. 이때문에 2022년에 회사에서 관리하는 문서 처리 방식을 싹 박꿨고 문서 개발에 더 많은 리소스를 추가했다고 합니다. 이런 노하우 공유는 언제나 환영입니다! :) 문서 개선을 주도했고 블로그를 작성했던 담당자 샤헤드 나세르(Shahed Nasser)는 소프트웨어 개발 회사에서 보통 문서화가 우선순위가 아닌데 이를 인식시키는 것만으로도 사실 성과라고 말합니다. 이후 회사 목표-로드맵-사용자 경험 개선 이렇게 우선순위를 정립했고요. 사용자 경험 개선 측면에서 문서화 주기 설정, 프로젝트 및 작업 진행 관리, 백로그 관리를 하며 ‘일을 찾아서 했습니다’. 그리고 다른 팀을 참여시켰습니다. 핵심 엔지니어링 팀, 제품 팀과 함께 같은 협업 툴을 쓰며 제품 업데이트 상황을 그때그때 문서에 반영했고요. 디자인 팀을 참여시켜서 문서에 브랜드 아이덴티티를 적용했고 기업 클라이언트들을 위해 제품 설명서를 게재한 홈페이지를 제작하는 등 도움을 받았습니다. 여기까지 메두사가 2022년 1년 동안 진행한 기업 문서화 개선 프로젝트 내용입니다. 굉장히 많은 일을 했어요. -제품 설명서를 통해 사용자 및 자사 개발자의 경험을 개선했습니다. -제품 및 개발 관련 문서를 싣기 위해 홈페이지를 전면 개편했습니다. -메두사 솔루션의 콘셉트와 가이드를 게재한 홈페이지를 구축했습니다. 물론 샤헤드 나세르는 문서를 업데이트 하고 다른 팀과 협업하는 지속적인 프로세스로서 사내 문서화 개선 프로젝트를 지속하겠다고 했습니다. 지금까지는 제품을 위한 문서화 집중했지만 2023년 목표는 좀더 개발자 중심의 문서화에 집중하겠다고 합니다. 2023년 후반에도 또 이런 노하우 공유 블로그 글을 내주면 좋을 것 같네요.

How we improved our documentation

Medusa

How we improved our documentation

다음 내용이 궁금하다면?

또는

이미 회원이신가요?

2023년 1월 5일 오전 10:42

댓글 0