인수인계

이 문서는 개발자가 다른 개발자에게 인수인계 해야할 항목들을 기획, 운영, 개발 항목으로 나눠 정리합니다.

주제

어느 항목들을 인수인계 해야 차기 담당자가 어려움 없이 개발에 쉽게 투입할 수 있을지 정리해보자.
🤔🤔🤔🤔🤔🤔🤔

회사의 서비스를 처음부터 종료하는날까지 혼자 개발⌨️하는 상황은 보통 없고, 큰 서비스일수록 그렇다.
그렇기에 평소에 프로그램에 대한 문서화가 잘 되어있어야 서비스 운영, 그리고 인수인계시에 문제가 발생하지않는다.


기획사항

  • 기존 작업 기획서 위치 (or 파일) 안내 및 내용 요약

    • wiki
    ex) Atlasian wiki, github wiki, trello ...
    • Jira Project
    • 사내 업무 게시판

운영 작업 안내

antenna-503044-unsplash.jpg

  • 운영 툴

    1. 계정안내
    2. 권한, 소유권 위임 및 탈퇴
    ex) 관리자 사이트, github, slack, facebook developers 등등
  • 협업 조직 담당자 소개

    ex) 기획자, 디자이너, 인프라 엔지니어 ...
  • 협업조직에 담당자 변경 알림

  • 기존 가입되어있던 비밀 계정 삭제 및 권한위임


개발사항 안내

DSC00010.jpg

서버사양

  • 서버 구성
  • 서버 도메인
  • ip, vip
  • 서버 접근 계정
  • 하드웨어 + OS 사양

SW사양

  • Language, Platform 버전
    ex) JDK, Tomcat, GO, DB, Nginx ...

DB

  • 서버 및 계정 안내
  • 테이블 및 스키마 명세
  • 프로시져, 트리거 항목이 있다면 인수인계

개발문서

  • 기존 작업 개발 문서 위치 (or 파일) 안내 및 내용 요약
    ex) Github Issue, 프로젝트 readme파일, API문서, 릴리즈 노트 ...
  • API, readme 문서 최신화 점검
  • 프로그램 위치 안내

소스코드

  • 불필요 주석 제거
    ex)
    # Author:... 
    # 1개월 뒤 갱신예정 ...
    # 2009. 01. 01 edited ...
  • 라이브러리 특정 버전 Dependency 등 코드로 확인 어려운 사항 기록

참조

스케쥴링

서버에서 주기적으로 동작하는 스케쥴링 프로그램의 존재, 빈도, 동작방법 안내

Git(or 별도 VCS)

brina-blum-156977-unsplash.jpg

  • 프로젝트 Remote URL
  • 기존 Git 운영 전략 안내
    ex) Commit 네이밍 규칙, Branch와 Tag 전략 등등
  • 외부로 연결된 hook 서비스들
    ex) jenkins, jira 등등
  • Issue 공유
  • wiki 공유

배포

  • 배포 과정 및 단계 소개
    ex) 수동배포, 배포 스크립트, Jenkins, GOCD ...
  • 배포 경로
  • 백업 및 롤백 절차 소개
  • 배포 환경 소개
    ex) dev, stage, prod

마치며

개발자도 굉장히 분야에 따라 인수인계해야할 사항이 많이 다르기에, 보편적인 항목 위주로 정리해 보았다.
보완해야할 사항이나 추가해야할 상황을 댓글로 달아주신다면 추가해보겠습니다.
😀😀😀😀😀

References