GitHub README 설치 가이드를 만드는 마크다운 템플릿

무엇을 해결하나

처음 방문한 개발자가 저장소를 실행할 수 있도록 요구사항, 설치, 환경 변수, 검증 명령을 빠짐없이 정리할 때 사용합니다.

준비할 정보

• 실제 적용할 환경과 대상 범위를 먼저 적습니다.
• 현재 상태와 기대 결과를 숫자나 예시로 준비합니다.
• 운영 데이터, 개인정보, secret은 제거하거나 안전한 placeholder로 바꿉니다.
• 변경 작업이라면 승인자, backup, rollback 가능 여부를 확인합니다.

복사해서 쓰는 템플릿

다음 프로젝트 정보로 README의 설치 섹션을 작성해줘.
프로젝트: {{PROJECT}}
지원 OS/runtime: {{RUNTIME}}
패키지 관리자: {{PACKAGE_MANAGER}}
설치 명령: {{INSTALL_COMMANDS}}
필수 환경 변수 이름: {{ENV_NAMES}}
실행·테스트 명령: {{RUN_AND_TEST}}

secret 값은 예시에 넣지 말고 실패 시 점검 항목도 작성해줘.

실행 순서

1. placeholder를 실제 환경 정보로 바꾸되 secret 값은 입력하지 않습니다.
2. 먼저 조회와 미리보기로 대상 범위, 권한, 현재 상태를 확인합니다.
3. 결과가 예상과 맞을 때만 가장 작은 단위로 실행하거나 초안을 생성합니다.
4. 변경 전후의 수치와 화면을 같은 조건에서 비교해 기록합니다.
5. 이상이 있으면 작업을 넓히지 말고 중단 조건과 rollback 절차를 따릅니다.

결과 확인

새 디렉터리에서 문서만 보고 설치를 재현합니다. 명령의 실행 위치, runtime 버전, lockfile 사용법, 성공을 판단할 출력이나 URL이 명시됐는지 확인합니다.

검수 결과에는 확인한 사실, 아직 확인하지 못한 가정, 다음 행동을 분리해서 남깁니다. 다른 사람이 같은 입력으로 재현할 수 있도록 환경과 확인 시각도 함께 기록하면 좋습니다.

주의사항

실제 token, 내부 URL, 개인 계정 경로를 README에 복사하지 않습니다. 운영 전용 값은 별도 보안 문서로 연결합니다.

AI가 만든 설명과 명령은 초안입니다. 실제 제품 버전과 조직 정책, 공식 문서를 대조하고 영향이 있는 작업은 dev나 격리 환경에서 먼저 검증하세요.