웹퍼블리셔 또는 마크업 개발자/UI 개발을 담당하고 있는 사람(이하 웹퍼블리셔)들에게 꼭 필요한 기술이 한가지 있다면 바로 문서화가 아닐까 싶다.
Trac과 같은 훌륭한 프로젝트 관리툴이 있고, 이를 이용하면 별도의 문서화가 필요없을 정도로 내부의 위키와 이슈트래킹 등이 훌륭하게 지원되지만 Trac은 협업(Co-work)을 위한 시스템으로, 개인 단위에서 문서화를 할 목적이라면 부담되는 것일 수 있다. 그래서 내가 하고 있는 문서화 방법을 공유해 보고자 한다. Trac과 같은 별도의 시스템을 사용하지 않고, 위키(스프링노트)와 메모장을 이용하는 비교적 간단한 방법이다.
내가 생각하는 웹퍼블리셔의 문서화는 다음 3가지 문서를 통해서 이루어진다.
- Markup Guide
기획 단계에서 작성 가능한 문서로 프로젝트의 간단한 개요와 HTML 문서의 DTD, Encoding, Meta 정보, 주석 처리 방식, 웹접근성과 웹표준화 적용 범위 등을 설정할 수 있다. 또한, 디렉토리 구조와 파일 네이밍 규칙, CSS 운용 방법, 기획 단계에서 요구되는 자바스크립트의 종류와 적용 범위 등도 함께 예측하거나 정리해 볼 수 있다. 이 문서는 프로젝트 발주자에게 제안되어 웹접근성과 웹표준의 범위를 결정하는데 도움이 되고, 개발자와 사전에 내용적 합의를 이끌 수 있는 문서다. 최초에 한번 작성해 두면 이 후 프로젝트에서는 몇가지 사항만 수정하면서 유지할 수 있다 - Issue Tracking
프로젝트 진행 중에 작성 가능한 문서로 각종 버그나 협업간 발생하는 이슈들을 기록한다. 프로젝트 진행중에는 시간을 갖고 문서를 작성하기가 여의치 않을 때가 많다. 때문에 짧고, 간단하게 기록하는 방식이 좋다. 메모장을 이용하여 날짜별로 파일을 저장해 두거나, 오픈마루의 레몬펜, 구글 노트를 이용하는 방법도 있다. 'issue_날짜_번호'로 제목을 만들고, txt 파일일 경우에 issue_080802_01.txt와 같이 만들면 되겠다. 내용은 '날짜_번호'로 이루어진 고유 번호와 1. 이슈내용, 2. 수정내용, 3. 요청 및 기타사항 을 적는다. 메모장으로 기록한 경우에는 프로젝트 종료 후 별도의 위키사이트나 스프링노트 등에 종합하여 정리하는 것이 보관하기 용이하다. - Publishing Report
프로젝트 종료 또는 웹사이트 오픈 직후에 작성 가능한 문서다. 어떤 프로젝트이건 기획 문서대로 완성되는 경우는 거의 없다. 때문에 Markup Guide를 작성하고, 개발자와 합의를 이끌었다고 하더라도 결과물에서는 제대로 반영되지 않았거나, 무시되는 경우가 많다. 이러한 사실을 기록하는 문서가 최종 Publishing Report다. 또한, 이 문서에서는 html, css, js등 파일수와 용량, 플래시나 동영상, 이미지 등의 정보를 수치로 기록하여, 정량화하여 사이트의 퍼포먼스 측정의 객관적인 자료가 될 수 있도록 한다. 아울러 HTML, CSS Validation을 실시한 결과 등을 포함하여, 스스로 웹표준화 정도를 측정하고 다음 프로젝트를 준비하는데 필요한 자료로 삼는다.
이 밖에도 웹접근성 향상을 위해서 주로 적용되는 'Cross Browsing'이나 각종 웹표준화 작업 이슈들을 문서화 해두면 프로젝트 진행에 도움이 되며, 협업간의 의사소통의 어려움을 극복하는데 힘이 된다. 이를테면 웹표준에 대한 인식이 부족한 기획자나 디자이너를 설득하기 위해서 침이 마르도록 설명을 해본들 잘 먹혀들지를 않는다. 하지만 구체적으로 보여줄 수 있는 문서가 있고, 결과물이 있다면 사정을 달라질 수 있다. 문서화는 웹퍼블리셔로 하여금 자신의 노하우를 축적하는 방법이기도 하면서 동시에 훌륭한 커뮤니케이션 수단으로써 이용될 수도 있는 것이다.
위에서 내가 적용해 보고 있는 3가지 문서와 방법을 간단히 소개했지만 특별히 검증된 것도 아니고, 반드시 좋은 것은 더더욱 아니다. NHN의 웹표준화팀이 운영하는 NULI에 보면 마크업과 CSS, 접근성 이슈들이 상세히 정리되고 유지되고 있는 것을 볼 수 있는데 문서화의 좋은 예라 할 수 있을것 같다. 회사와 개인마다 조금씩 가이드가 다를 수 있고, 프로세스와 스타일이 다를 수 있기 때문에 꼭 남의 것을 따르기 보다 참조하여 자신의 것을 만들어 가는 것이 더 좋을 것이라는 생각도 해본다.
