SW개발시 문서화에 대한 생각

SW개발시 좋은 문서를 만드는 방법에 대한 제 생각입니다.

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

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

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

양보다 질좋은 문서를 만들기는 어려운것 같아요. ^^