정보, 통신, 기술/개발? 개발! 개발^^

개발직군에 문서 도우미 역활

최윤호 2008. 4. 25. 09:13
반응형
개발직군에는 개발자를 도와주는 TA(technical assistant)가 있습니다.
기술 도우미(?) 정도로 풀어 설명할 수 있는 것으로 개발에 있어 중요한 기술적 이슈가 발생했을 때 개발자를 도와 문제를 해결하는 역활입니다.

전 이와 비슷하게 DA(document assistant)가 있으면 좋겠다고 생각합니다.
문서 도우미로 코드를 문서로 전환해 주는 역활이죠.

프로그램은 코드로 표현됩니다.
하지만, 코드를 분석하는 것은 쉽지 않은 일이고, 프로그램의 작동을 이해하고 있어야 하는 기획자에겐 많이 어려운 일이죠.

따라서 많은 경우 문서화 작업을 진행합니다.
하지만, 아쉽게도 여러가지 이유로 문서는 적절하게 유지 되지 못하는 경우가 발생합니다.
아예 갱신이 안 되거나, 갱신이 되더라도 작성자가 바뀌고, 시간이 흐름에 따라 스타일이 변합니다.
정확히 갱신되지 않고 정보가 누락되거나 중복되고, 정보 안에서도 차이가 발생하는 경우도 있습니다.

이에 문서화를 전체적으로 관리하는 개발직 DA가 필요합니다.
DA는 문서를 관리하고, 필요할 때 적절히 제공하는 역할을 수행합니다.
문서 유지와 관리 방법을 만들고, 문서 작성의 규칙과 문서 이용의 방법을 정합니다.

개발자들이 1차 문서화 작업에 적용할 문서 작성의 가이드를 제공합니다.
그리고 개발자들이 작성한 문서를 검토해서 수정, 보완하고 기존 문서와 함께 보관합니다.
이를 통해 문서는 통일성을 유지한채로 계속 갱신되게 됩니다.

그리고 개발자나 기획자가 관련 자료를 요청할 때 제공합니다.(도서관 사서의 역활일까요?)
여전히 코드가 중심이지만, 코드와 문서와 차이가 없다고(혹은 적다구^^) 믿는 것이죠.

어쩌면 QA(quality assurance) 역활과 비슷해 보이기도 합니다.
QA가 기획서와 설계서에 따른 소스를 검토한다는 점에서 말이죠.
QA의 하위 역활로 DA가 들어가도 괜찮을 것 같습니다.

중요한 것은 문서화 작업이 통일성과 체계성 그리고 효과성을 갖도록 하는 역활이 필요하다는 것입니다.
반응형