인수인계(Handover) Doc 작성법 (Code Base)

https://www.thinslices.com/blog/the-10-commandments-of-a-successful-project-handover

Check List

Planning : 인수인계를 하기전 준비단계

1. Handover 할 사람들을 명확하게 하기.
   • 팀의 리더, 프로젝트 매니저와 몇몇 팀 멤버들(관련된) 에게 전달.
   • 인수인계 단계에서 모든 사람들의 역활이 명확해야 한다.
   • 개인과 팀은 인수인계받은 프로젝트를 계속 해나가야 하는 책임이 있다.
2. 인수인계 Deadline 명확하게 하기.
3. Communication Plan 을 인수인계하기 전에 미리 짜기
   • 언제 누구와 어떤 정보를 전달할 것인지 계획하기.
   • Detail 하게 할 필요는 없지만 필요하다.

Knowledge transfer : 인수인계하기

1. 인수 인계할 정보를 readme에 업데이트 하기.
   • readme 파일은 아래의 정보를 가져야 한다.
     1. project description
     2. 프로젝트 setup 방법
     3. 로컬에서 project를 실행하는 방법
     4. 이용하는 3rd party library api / 다른 앱과 소통하는 api
     5. production 레벨로 배포하는 방법
     6. API 문서
     7. Project의 Architecture Design 에대한 정보 : 어떤 아키텍쳐를 썼는지에 대한 정보.
     8. app/code의 구조
     9. 관련된 다른 정보들 : 프로젝트를 handover 받을 새로운 개발자가 당신의 도움 없이도 이해하기 쉽게 하기 위한.
2. 지식전달 세션(발표회)하기
   • 인수 인계에 관련된 Knowledge 관련 session을 하는 것은 매우 도움이 된다.
   • 질문을 하고 확인하는 과정을 통해 원활한 인수인계 환경을 만들어 준다.

Deliverables : 인수자에게 전달해야 할 것

1. Code 접근 권한 주기
   • github, gitlab, bitbucket 등에 대한 ownership을 줄 것.
2. 계정 넘겨주기(eg.3rd party services) & Credential 넘겨주기
   • AWS/server hosting, database, GooglePlay/AppStore, mailing service apps, SSL certificate files 등
3. Project의 App admin 권한 부여, Demo account 넘기기
   • Account 에 대한 정보를 적고, 해당 account로 app 에 들어갔을 때 알수 있는 것을 간략하게 적기.
   • 만약 Account에 민감한 개인정보가 있다면 지울 것.
4. Documentation 전달과 필수요구사항(프로젝트 세팅할 때 필요한) 전달하기
   • 인수자가 Document에 Access 할 수 있도록 하기.
   • 가장 좋은 방법은 인수자의 계정으로 프로젝트를 세팅하는 것.

Communication : 인수인계 내용 전달하기 (Final)

1. 인수인계 이메일 보내기
   • 인수인계 정보가 어떻게 구조화 돼 있는지 짧은 설명을 담고, 관련된 링크가 포함된 인수인게 이메일을 보냄으로 인수인계 과정을 마친다.