2009년 7월 23일 목요일

프로젝트 문서 관리

실제로 프로젝트를 진행하다 보면 소스이외의 많은 문서들과 설계 자료를 만들고

관련된 참고자료를 수집하게 된다.

 


이러한 문서자료를 관리를 위한 방법에 대해서 마소에 2006년 4월에 게재되었던

기사를 참고로 나름대로 정리를 해보았다.

 

우선 요구사항


  • 소규모 그룹을 위한 방안
  • 개발자는 규칙에 얽매이는 것을 싫어한다.
  • 시간이 흐른 후에도 찾아야 할 경우가 종종 발생한다.
  • 백업이 간단해야 한다.

 

프로젝트 진행용 파일 관리법


  • 탐색기를 사용하는게 편하다고 필자는 말하고 있으나 개인적으론
    SVN등의 툴을 탐색기와 연동하거나 TOW등을 사용하는게 좋다고 판단된다.

  • 위키 프로젝트 문서 관리법

    1. TOW에 프로젝트를 등록한다.
    2. 프로젝트에 관련된 간략한 요약내용을 정리해서 wiki의 첫페이지를 생성한다.
    3. 첫페이지 하단에는 아래와 같은 링크 wiki페이지를 만든다.

      • design : 설계 관련문서 - 분석,설계,개발 관련 문서 페이지
      • design_memo : 설계 관련 내역 - 설계시 이슈가 되었던 내역등을 기록
      • maintenance : 유지보수관련문서 - 유지보수때 추가적으로 발생한 문서 페이지
      • maintenance_memo : 유지보수내역 - 유지보수했던 내역을 요구사항이 들어올때마다 기록
      • manual : 산출물 - 납품했던 산출물
      • sample : 각종 샘플 - 테스트용으로 사용했던 샘플 첨부 페이지
      • refer : 참고자료 - 개발시 참고했던 자료 및 링크 등을 정리한 페이지
        (링키는 시간이 지나면 사라질 수 있으므로 될수 있으면 링크와 참고자료를 동시에 보관하는게 좋다)

 

  • 문서의 명명 규칙

    • 문서는 문서 앞쪽에 4자리의 코드를 부여하는데 영문(1)+숫자(3)로 생성한다.
    • 영문은 원하는 이니셜을 사용하면 되고 커다란 의므로 사용된다.
    • 숫자는 문서의 생성 순서에 따라 증가한다.
    • 어떤 작업에 관하여 문서를 생성하게 될때는 보통 하나의 문서로 정리될 수도 있지만 여러개의 문서가 한번에 발생할 경우 동일한 코드를 가짐으로 동시에 작성되었다는 표시로서의 의미를 가진다.

 

  • 백업

    • 백업은 위의 자료가 업로드 되어 있는 TOW를 통채로 백업하는 방식을 추천한다.
    • 백업용 씽크 프로그램으로는 GoodSync가 적당하다.(윈도우일 경우)
    • 백업용 데이터는 실제 저장된 디스크와 다른 곳에 백업을 처리하며
    • 자동화된 일일 백업을 처리하고
    • 안전을 위해서 월 1회 실제 저장소와 백업 저장소 이위의 공간에 백업을 한다.(옵션)