매뉴얼은 꼭 필요한 산출물인가?

유지보수 조직에 투입되어 산출물 품질관리 수준을 살펴보면 대부분 필수 산출물이 정의는 되어 있으나 방치된 채 이름뿐인 경우가 많다.

그 중에서도 유지보수/운영시 가장 중요한 산출물은 운영자 매뉴얼일 것이다. 운영자 매뉴얼이라 함은 특정 문서 하나를 의미한다라기 보다는 운영에 필요한 참고 문서/산출물 꾸러미를 통칭하는 것이다. 용어사전, ERD, 테이블설계서, 프로그램설계서, 테스트케이스, 배치작업정의서, 인터페이스정의서, KEDB(Known Error Database), 장애대응매뉴얼 등 많은 문서를 포함할 수 있다.

하지만 현장에서는 운영자매뉴얼을 정비하라는 가이드를 하면, 바로 템플릿을 달라고 요구한다. 무엇을 어떻게 작성해야 할지 모른다면서.

이름그대로 어떤 한 시스템의 운영을 새롭게 맡은 담당자가 매일, 주간 또는 월간으로 시스템 운영 및 유지보수를 위해 모니터링, 배치 작업수행, 이상징후 이벤트, 장애발생 시 즉각적으로 조치할 수 있는 문서, 체크리스트 등이 운영자 매뉴얼인데 어떻게 하나의 포맷으로 한정지을 수 있을 것인가? 물론 위에 언급한 내용을 카테고리화해서 항목으로 만들어 운영자 매뉴얼 템플릿을 제공할 수 있을 것이다. 그렇게 한적도 많다.

운영자 자신에게 가장 필요한 문서를 정리한다고 생각하면 형식은 운영자 본인이 가장 잘 알것이다.

이런 운영자 매뉴얼이 대부분의 조직에서는 관리가 잘 안되고 방치된다는 것은 이해가 되지 않는다. 그래서 리더들에게 이러한 문제를 보고하면 바로 이어지는 조치는 산출물 현행화를 하라는 과제가 내려간다.

"한달내로 미비한 산출물을 무조건 할 것..."

이러면 결과는 어떻게 될까?

예상하겠지만, 껍데기만 만들고 내용은 부실할 가능성이 높다. 안되어 있는게 너무많아서 다른 일을 못한다고 항변하거나, 포기하고 버티게된다.

그래서 특정기간을 두고 CSR(Customer Service Reqeust) 같은변경 요청이 있을 때 관련 산출물이 없거나 미비한 것은 그 때 고치도록 가이드하고는 하지만 여전히 산출물 현행화는 지속화되기 어려운 숙제다.

 

그런데 운영자매뉴얼과 사용자매뉴얼의 차이는 무엇일까? 이름만 봐도 명확하게 이해가 될텐데. 운영자매뉴얼을 사용자매뉴얼과 똑같이 생각하거나, 화면별로 설명을 하는 형태로 운영자 매뉴얼을 만드는 경우는 잘못된 생각이다.

사용자매뉴얼은 사용자의 관점이니까 주로 사용자에게 노출되는 화면별로 설명하는 것이 맡지만, 운영자 매뉴얼은 화면별로 정리할 필요는 없다. 아니 그렇게 해서는 좋은 매뉴얼이 아니다. 다시 말하지만 시스템 안정을 위한 운영작업에 필요한 내용을 정리하는 것이다. 물론 사용자 매뉴얼이 잘 구비되어 있다면 이것도 운영자 매뉴얼의 한가지로 포함될 수는 있는 것이다.

​

그럼 사용자 매뉴얼은 어떤가? 프로젝트 수행시 고객에게 제출하는 필수 산출물이 사용자 매뉴얼이다. 그리고 대부분 프로젝트 막바지에 사용자 교육을 할 시점에 급히 만들게 된다. 항상 급박한 시점이 그 때이기 떄문에 많은 시간이 필요한 사용자 매뉴얼 작성 타스크는 부담되는 일이다. 화면을 일일이 캡쳐해서 붙여놓고 화면 버튼, 필드, 선택값 별로 설명을 달아야 하는 일은 많은 공수가 소요된다.

또한 관련 기능이 변경되거나 화면이 변경되면 매뉴얼을 또 다시 바꾸어야 한다.

왜 매뉴얼이 필수 산출물이 되어야 하나?

그래서 매뉴얼 작업을 줄이기 위해 어떤 프로젝트는 온라인 매뉴얼을 화면별로 설계하는 것을 초반부터 범위에 포함하고 설계하기도 한다.

휴대폰을 새로 장만해서 케이스를 뜯게 될 때 과거에는 꽤 두꺼운 사용자매뉴얼이 동봉되어 있었고, 그걸 한페이지씩 놓치지 않았던 기억이 난다. 그런데 요즘 신형 휴대폰을 구입하면 매뉴얼이 몇장되지 않는다. 굳이 매뉴얼을 보지 않아도 사용자가 기존의 휴대폰에 대한 익숙함에 실제로 눌러보면서 이해하게 되기 때문이다.

소프트웨어도 마찬가지가 아닐까 생각한다.

직관적인 UI로 잘 설계가 된다면, 별도의 산출물이 필요없거나 최소한으로 만들고 화면에 풍선말 등의 도움말로 대체 될 수 있을 것이다.

형식적인 산출물 작성에 시간을 투자하는 것 대신 정말 꼭 필요한 것, 의미있는 것 중심으로 최소한의 매뉴얼을 만들어 보자.