개발문서
문서를 왜 작성해야 할까?
-
문서는 공유이다.
협업이나 혼자 프로젝트할 때 내용을 작성하는 다른사람들에게 내용을 공유함과 동시에 본인에게 조차 내용을 공유하기 위하여 문서를 작성한다.
(완벽한 기억한 불가능하다.. ) -
히스토리 관리 문제나 요구상황에 대한 분석 내용이나 알고리즘을 등을 정확하게 기록한다. 개발범위를 명확하게 파악하는 것 외에도 추후 리팩토링이나 문제가 생겼을 때 문제를 파악하는데 큰 도움이 된다.
-
인수인계의 용이성
말이 필요한가? ㅎㅎ
잘 작성된 문서만으로 인수인계가 필요없다…
원페이저란?
꼭 필요한 내용을 한 장짜리 정리한 개발문서 양식
원페이저 작성원칙
- 쉽고 간결하게
- 사실과 의견 구분
- 일기 쓰지 말 것
- 디자인 시간 낭비 하지 마라
- 변경사항 관리
템플릿
-
타이틀
(프로젝트 이름, 문서 작성자, 작성날짜, 목차 등) -
프로젝트 설명
(다른사람이 이해할 수 있도록 프로젝트를 요약한 설명) -
산출물
(프로젝트에서 어떤 결과물이 나오는지 정확하게 기재) -
비즈니스, 마케팅 타당성(왜 해야하는지)
(프로젝트를 해야하는 근거, 프로젝트의 정체성) -
리스크 평가
(프로젝트 중 예상되는 문제와 대응방안) -
일정/참여 인력
(몇 몇이 언제까지 개발할 것인지, 시간과 인력을 얼만큼 활용할 수 있는지에 대한 계획) -
기술설명 (개념, 동작원리 등에 대한 설명 글보다 그림을 그리는것을 추천)