문서화..

카테고리 없음 2012. 9. 19. 14:25

개발을 하다보면 문서를 만들어야 할때가 많다. 

특히 개발 산출물은 코드와 동일한 가치를 갖는데 심지어 파일럿 프로젝트에서는 코드보다 더 중요하다. 이것을 기반으로 개발이나 유지보수가 진행되기 때문에 혹시 개발과정에서 만들지 않았더라도 개발관련 문서는 만드는 것을 권장한다.


그런데 모든 프로젝트에서 개발 문서가 중요한 것은 아니다. 중요하긴 한데 더 중요한 문서가 있다는 것이다.


패키지를 개발하는 프로젝트에서는 매뉴얼이 더 중요하다. 개발에 대한 내용은 대충 위키나 코드에 주석으로 처리하여도 되지만 매뉴얼은 정말 열심히 작성해야 한다. 

이것이 소위말하는 SI프로젝트와 패키지 프로젝트의 가장 큰 차이점이다.


그러면 패키지 프로젝트에서 필요한 문서는 뭐가 있을까/


  • 레퍼런스 매뉴얼
  • 유저스 매뉴얼
  • 설치 매뉴얼
  • 릴리즈 노트
  • 퀵스타트 매뉴얼
  • 소개 PPT
  • 화이트페이퍼 - 제품 포지션, 핵심기술, 핵심 가치
  • 기술 브로셔
  • 영업 브로셔
  • 제품 도입 스펙
  • 타제품과 비교자료


Posted by sjokim
,