Flowly Castly
메뉴

2025-01-09

온보딩 첫 주에 만드는 “실행 가능한 README”

작성: 박민재

온보딩 첫 주에 만드는 “실행 가능한 README”
README는 장식이 아니라 실행 스크립트의 첫 페이지입니다. 명령을 나열하기 전에, 필요한 도구 버전과 권한을 표로 정리합니다. 각 단계 끝에 “성공 시 출력 예시”를 한 줄 넣습니다. 실패했을 때의 메시지도 함께 적습니다. 마지막에 건강 검사 커맨드를 두어 네트워크 없이 확인 가능한지 구분합니다. 주간 멘토링에서 가장 많이 고쳐지는 부분은 “암묵지로 남아 있는 환경 변수”입니다. 이름과 예시 값, 보안상 비워야 하는지 여부를 표로 박제하세요. 이 글은 특정 클라우드 벤더 구독을 전제로 하지 않습니다. 로컬과 스테이징에서 재현 가능한 최소 루프를 목표로 합니다.
#온보딩#문서#환경