[개발 문서화] 프로그램 개발 문서화

-문서화를 통한 얻을 수 있는 점.

1. History 작성.

2. 일주일, 몇달 계획을 세워 하루 코딩 작성량 및 전체적인 조율.

3. 서로의 스케줄을 공유를 통한 git, SVN을 통한 형상 관리 시 push 및 머지 시 충돌 미연 방지.

4. 마인드 맵을 통한 전체 적인 데이터 구조 작성

5. 퇴사 시 인수인계에 용이.

등 있는 거 같다.

1. OneNote

약식 이긴 한데 저런 식으로 일정 작성 및 공유 목적으로 사용.

개발 완료는 체크.

2.X mind

mind map을 통한 input output data에 대한 정리로 사용.

3. MarkDown

위 사진은 퍼온것  History를 .md 파일로 저장.

md 파일은 일반 연습장(notepad와 다르게 문법을 통한 글씨 굵기 설정, 선 그리기, 사진 삽입 등이 가능.

4.ppt

가장 친숙한 툴.

얘는 User Manual 작성, History, Meeting등 많은 곳에 사용한다.

다인 개발시 문서화는 거의 모든 회사가 필수라서 싫어도 해야한다.

1인 개발에 익숙해진 사람들이 간간히 문서화를 해보길 바라며 포스팅 해본다.

정해진 방법은 없다. 물론 교재에 나오는 전문적인 용어와 단계들이 뭐 어쩌고저쩌고가 있는데 결국에는 자신과 함께하는 동료들과 문서화 방법을 고민하고 점진적으로 발전해 나가는게 가장 바람직 한거 같다.

끝.