그저 아키텍쳐 설명하고 코드 훝어주라고 하셨는데 왠지 찜찜해서,
적당히 검색해보니 다음과 같은 것들이 필요하다

1. 아키텍쳐 설계서
2. 프로그램 명세서
3. DB 속성 테이블 정의서
4. 요구사항 정의서
5. 분석 설계서
6. 테스트케이스 / 테스트케이스 결과서
7. 메뉴얼
8. ERD

아키텍쳐 설계서는 없어서 만들어야겠다.
프로그램 명세서랑, 메뉴얼은 소스코드 repository에 같이 들어있다
요구사항은 수주 받은 프로젝트가 아니였으므로 패스
분석 설계서. 이건 뭔지 잘 모르겠다.
테스트 케이스는 QA팀에서 엑셀파일로 주었고,
테스트 케이스 결과는 mentis라는 오픈소스 이슈관리 프로그램에서 확인할 수 있다.
ERD는  DBDesigner4로 작성한 xml파일이 있다.

후임에게 실질적으로 도움이 되는것은 소스코드에 주석을 다는 일인 것 같다는 생각이 들었다.
그리고 의외로 대부분 문서화가 잘 되 있어서 도움이 많이 되었다.
찾아보지 않는 문서는 죽은 문서지만 그래도 있으니 찾아서 쓰게 된다.
그리고 지금부터라도 주석을 달아야겠다는 교훈을 얻었다.



Posted by 김민우 julingks