약 2주 전엔 nFORGE의 위키를 개편하였다. (작업 날짜를 보니 10일 정도 지났군요.) 위키 정리한 내용을 블로그에 정리해야지라고 생각만 하다보니 벌써 10일이나 흘렀다.
개편 이유
오픈 소스 프로젝트를 준비하면서 딱딱한 위키 페이지보단 개발자들이 정감있게 읽을 수 있는 것이 목표였다. 그래서 캐주얼하게 위키를 구성하다가 보니 위키 페이지에서 내용을 찾는 것이 어렵게 구성되었다. 오픈 소스 프로젝트에 대한 벽을 없애는 것을 치중하니 경직된 느낌을 주지 않기 위해 노력했다. 아래 그림을 보면 쉽게 이해가 될 것이다. (정말 문장 하나하나가 캐주얼하고 개발자의 위트를 발휘하려고 노력했었다.)
결과적으로 처음 위키에 방문한 사람은 모든 내용을 정독하지 않으면 안 되는 형태였다. 11월 20일에 오픈하고, 1달이 지난 시점에서 복잡하다는 느낌이 부쩍 많이 들었다. 업무는 계속 주어지니까 눈 앞에 깔끔한 위키를 만드는 것이 만만치 않았다.
이 차장님도, 오 과장님도 똑같이 느끼고 있었을 것이다. 그러던 중 오 과장님이 다른 오픈 소스 프로젝트랑 자주 비교하다가 보니까 “이건 아니다!!”란 선언을 했고, 우리도 그와 관련해서 이미 공감하고 있었기 때문에 더 고민하지 않고 작업을 하기로 결심했다. 모든 일은 하자고 말이 나왔을 때 하지 않으면 우리의 기억 저편으로 사라지기 때문이다.
작전
우리의 창의력이란 게 보통 사람들 수준이라서 어떤 내용을 어떻게 정리할지 결정하기 전에 어떤 페이지를 참고할 것인지를 조사했다. 비슷한 오픈 소스 프로젝트들은 어떤 내용을 어떻게 정리하는지 조사하니 그나마 PostgreSQL이 맘에 들었다. 구성은 여기 내용을 참고하기로 하고, 내용 분류를 어떤 식으로 할까 고민을 하였다.
“개발자들이 와서 헷갈리는 이유가 뭘까?” 하는 화두를 해결하기 위해 고민을 했다. 우리의 결론은 제품 자체, 오픈 소스 프로젝트 자체, 그리고 문서로 분류를 해 보았고, 특히 오픈 소스 프로젝트에서 개발자들이 할 일이 무엇인지를 명확하게 정리하기로 의견을 모았다. 이전 페이지는 개발자는 이런 일을 할 수 있고, 테스터는 저런 일을 할 수 있다고 얘기하니까 페이지가 복잡하였다. 단순하게 코드 패치하는 방법, 문서 작성하는 방법, 버그 리포팅 하는 방법과 같이 단순하게 정리하였다.
작업 시작!
내가 위키 페이지를 구성한 원흉이었기 때문에 구 페이지 백업은 나의 담당이었다. 난 열심히 위키 소스를 열심히 백업하여 문서를 작업자들에게 배포하였다. 이제 작업하기로 한 날만 오기를 기다리고 있었다.
작업 하기로 한 날, 출근하는데 서비스 중인 페이지를 큰 손실이 없이 엎어치는 방법이 뭘까라고 고민이 되었다. 오 과장님이 지금 서비스 되고 있는 페이지의 아래에 그대로 작업하자는 혜안을 제시하였다.
우리의 작업은 그렇게 시작되었다. 아침 나절에 모두 하기로 하였는데, 내가 하기로 한 부분은 개발자들이 참여하는 방법이라서 전면적인 개편이었기 때문에 조금 오래 걸렸다. 하지만 점심 먹고 들어와서 마무리하여 모두 완성하였다. 우리는 박수를 치고 기뻐했다.
근데 문제점이 하나둘씩 보이기 시작하였다. 옆 팀에서 “빌드하기” 페이지를 보고 있는데, 히스토리에서 뒤져서 보고 있는 것을 발견했다. 아차 싶어서 얼른 예전 페이지를 주욱 보니까 “빌드하기”와 “소스 구조” 의 링크가 빠진 것이다. 빌드하기는 처음 시도하는 사람들이 많이 보는 것이기 때문에 꼭 해야 하는 것이고, 소스 구조는 잘 보지 않는 페이지이긴 하지만, 앞으로 계속 작업을 할 것이기 때문에 남겨둬야 하는 페이지인 것이다. 빠진 페이지를 찾고 모두 링크를 정리하였다.
작업 완료!
짜잔! 우리의 노력으로 페이지를 아래와 같이 단순하게 정리하게 되었다. 깔끔하고 좋지 않나? 읽을 거리가 많은 것보단 내용이 한 눈에 들어오는 게 역시 편한 것 같다.
작업 후기
정말 개편을 결심하고 실제 작업한 시간은 Net로 보면 4시간~5시간 정도인 것 같다. 하지만 팀장님과 랩장님께 상의하면서 할지, 대략 방향만 상의하고 그냥 후다닥 작업을 할지 초반에 갈피를 잡을 수가 없었다. 사실 방향만 상의하고 실무자들 선에서 하면 될 것이라고 생각은 했지만, 자신은 없었다.
오픈 소스 프로젝트는 수많은 개발자의 눈을 무시할 수 없고, 사소한 것 하나하나가 개발자들의 생각에 영향을 주는 것이므로 뭘 해도 조심스러울 수 밖에 없다. 그래서 모든 것이 팀장님과 랩장님은 알아서 실무자 선에서 알아서 해주길 바라겠지만, 실무자들은 살짝 부담스러울 수 밖에 없는 것이다.
페이지 정리는 했는데 앞으로 어떻게 내용을 채울지가 솔직히 고민이다. 오픈 소스 프로젝트의 꽃이라면 뭐니뭐니해도 개발자 친화적이고 풍부한 문서가 아니겠는가?! Documentation 분류 아래에 수많은 문서를 채워서 검색 기능을 추가하자는 의견이 나올 때까지 글을 채워보고 싶다.
우리 모두 큐브리드 사용 Tip이나, 개발 Tip 작성하러 가요~. 1인 1Tip 캠페인을 벌여보는 건 어떨까?
