2007년 07월 21일
SW개발시 문서화에 대한 생각
SW개발시 좋은 문서를 만드는 방법에 대한 제 생각입니다.

1. 간결하고 보기 쉽게 만든다.
당연한 이야기 입니다. 어린이가 봐도 이해할 수 있는 문서가 좋은 문서라죠.
Simple is best!

2. 너무 세분화 하지 않는다.
어떤 문서 양식은 이 칸에 무슨 내용을 넣어야 할지 또는 이 내용은 어떤 칸에 넣어야 할지 고민되게 합니다.
일단 큼직하게 분류하고 필요에 의해서 세분화 시키는 것이 좋습니다.

3. 개발에 도움되게 만든다.
요구사항 명세서를 예로 들면 명세서를 보고 기능 구현의 우선순위, 전체 진행상황 파악등에 사용될 수 있습니다.
만든 문서가 개발시 참고할 가치가 없고 아무런 도움이 안된다면 문서따로 개발따로 노는 것입니다.

양보다 질좋은 문서를 만들기는 어려운것 같아요. ^^
by -A2- | 2007/07/21 22:09 | 개발/플밍 | 트랙백 | 덧글(2)
트랙백 주소 : http://ani2life.egloos.com/tb/3295833
☞ 내 이글루에 이 글과 관련된 글 쓰기 (트랙백 보내기) [도움말]
Commented by 즈모모 at 2008/07/07 09:41
크읍... 여기도 프로그래머가 계셨군요... 놀랄건 아니지만,
요새 문서화라는건 만져보지도 못한 상황에서 문서화를 진행해야 된다는것에 대해
미칠꺼같군요... 돌아버릴지도...

orz 사회초년생한테... 기획 및 개발문서를 가져오라는건 orz 고문아닌 고문입니다..
지금 조금이지만 심한 압박을 받고 있습니다. 내가왜 내가왜 웹을 한다고 해서...어어억...
죄송합니다. 첫 댓글인데 이리 심각해서야 자아 다시 쿨하게...

간결하게 만드는것도 어렵고 세분화하지 않는것도 어렵고 개발에 도움되게 하는건 더어렵네요..
작성은 했지만 통과될지부터가 문제입니다. 남들보다는 잘해야지라는 부담도 있고...

차라리 사무직을 했으면 편했으리란 생각까지 들게하네요... 여러가지 관점을 가지고 다방면에서
봐야하니까 문서가 더욱 덕지덕지가 되는것 같기도 하구요... 그래서 물어보는데...


기획문서 작성시에는 어떤 관점을 가지고 작성을 하는게 좋을까요... 어떤 내용이 들어가는게...

선배님 부탁드립니다 (꾸뻑)...
Commented by -A2- at 2008/07/07 22:29
선배님이라니 감사하고 부담도 되네요. ^^;
프로젝트 기획문서에 대해서 제가 조언드릴 실력이 아니라 다른 문서들을 보고 참고해보세요. ㅠㅠ

그래도 간단하게 적어볼께요.
기획문서의 관점은 프로젝트 결정권자와 사용자의 관점에서 작성하세요.

그리고 들어가는 내용들은
- 이러이러한 문제가 있다.
- 이 문제를 해결하기 위한 프로젝트이다.
- 프로젝트 완성시 이런 이익이 발생한다.
- 이정도 인원, 기술, 일정, SW/HW 비용이 예상된다.
- 예상되는 문제점은 어떤 것이 있다.
- 그리고 프로젝트에 대한 기능, 특징등 다양한 소개

프로젝트의 방향과 성격을 결정하는 기획이라면 이런 것들이 필요할 것 같구요.
경우에 따라서 사이트맵, 스토리보드 같은 것 까지 필요할 수 있습니다.

별로 도움 드리지 못했네요. ^^

:         :

:

비공개 덧글



<< 이전 페이지 | 다음 페이지 >>