온보딩 문서 생성

좋은 온보딩 문서는 새 팀원이 첫날 로컬에서 프로젝트를 실행하고, 어디서부터 코드를 읽어야 하는지 알게 해 줍니다. Specify는 저장소 구조와 실행 방법을 근거로 온보딩 문서를 생성하고, 코드가 바뀌면 함께 갱신합니다.

좋은 온보딩 문서의 구성#

1. 이 프로젝트는 무엇인가 — 한 문단의 개요와 주요 구성 요소
2. 로컬 실행 — 필요한 런타임과 버전, 설치, 환경 변수, 실행·테스트 명령
3. 저장소 지도 — 주요 디렉터리와 진입점, 어디서부터 읽으면 좋은지
4. 개발 흐름 — 브랜치 전략, 리뷰, 배포 절차
5. 도움을 받는 곳 — 담당자, 관련 문서, 자주 막히는 지점

생성하기#

1. 문서 프로젝트 만들기

   온보딩 대상 저장소를 소스로 연결하고, 온보딩 가이드를 만드는 문서 스킬을 선택합니다.

2. 강조할 점 적기

   읽을 사람과 목표를 구체적으로 적습니다. 예: "입사 첫 주 백엔드 개발자가 로컬 실행과 첫 PR까지 도달하도록".

3. 사람이 보완하기

   코드에서 알 수 없는 내용 — 팀의 합의, 담당자, 권한 요청 절차 — 은 생성된 문서에 직접 보완합니다.

검증하기#

생성된 문서는 실제로 따라 해 보는 것이 가장 확실한 검증입니다.

• 새 환경에서 문서의 명령만으로 설치와 실행이 되는지 확인합니다.
• 환경 변수와 시크릿의 이름만 적고 값은 문서에 넣지 않았는지 확인합니다.
• 막힌 지점은 문서에 바로 반영해 다음 사람이 같은 곳에서 막히지 않게 합니다.