9강. 실행 방법 검증: 다른 사람이 따라 할 수 있는 재현 절차 만들기

?1. 이번 강의에서 해결할 문제

작성자 컴퓨터에서만 되는 절차는 공개 실행 방법이 아닙니다. 숨은 전역 설치와 로컬 경로를 제거하고, 프로젝트 종류에 맞는 명령과 예상 결과를 기록합니다.

✓2. 학습 목표

✓이번 강의를 마치면

• 필수 도구와 실제 검증 버전을 기록합니다.
• 시작 경로, 명령, 예상 결과와 종료 방법을 씁니다.
• 깨끗한 터미널 또는 새 작업 폴더에서 절차를 재현합니다.

◇3. 핵심 개념

재현 절차에는 사전 조건 → 프로젝트 열기 → 의존성 준비 → 실행 → 성공 신호 → 종료가 필요합니다. 여러 프로젝트 유형을 한꺼번에 쓰지 말고 선택한 프로젝트에 해당하는 절차만 남깁니다.

✎4. 단계별 실습

문서 작업 · 산출물: <PROJECT_ROOT>/docs/run-guide.md

docs/run-guide.md

# 실행 가이드

## 검증 환경
- OS: Windows 11
- 도구: 실제 확인한 엔진·JDK·Python·Node.js 버전 중 해당 항목

## 실행 위치
모든 명령은 저장소의 최상위 폴더에서 실행합니다.

## 실행 절차
1. 필요한 도구가 설치됐는지 `--version` 명령으로 확인합니다.
2. 프로젝트에 이미 정의된 설치 또는 빌드 명령을 실행합니다.
3. 프로젝트에 이미 정의된 실행 명령 또는 시작 Scene을 사용합니다.

## 성공 신호
- 예상 화면, 콘솔 문장 또는 Unity Play Mode 상태를 구체적으로 기록합니다.

## 종료
- 콘솔 프로그램·로컬 서버: `Ctrl+C`
- Unity: Play 버튼을 다시 눌러 Play Mode 종료

PowerShell · 실행 위치: 프로젝트 루트

Get-Location
Get-ChildItem
git status --short

웹은 프로젝트에 package.json이 있을 때만 기존 npm 스크립트를 사용합니다. Python은 프로젝트에 정의된 가상환경·모듈 실행법을, Java는 포함된 Gradle Wrapper나 현재 빌드 문서를 사용합니다. Unity는 기록한 정확한 Editor 버전으로 Hub에서 프로젝트를 열고 시작 Scene을 확인합니다. 없는 도구나 명령을 새로 꾸며내지 않습니다.

Python 프로젝트가 패키징 메타데이터를 제공한다면 README·라이선스 선언 방식은 Python Packaging User Guide의 pyproject.toml 명세를 확인합니다.

완료 기준: 새 PowerShell에서 문서만 따라 대표 흐름이 실행되고, 실제 결과와 종료 방법이 기록됩니다.

§5. 작성 방식이 필요한 이유

실행 검증은 숨은 의존성, 잘못된 상대 경로와 누락 파일을 공개 전에 발견합니다. 독자가 실패했을 때 어느 단계에서 무엇을 기대해야 하는지도 알 수 있습니다.

!6. 자주 하는 실수와 해결법

!자주 하는 실수

• 내 컴퓨터의 절대 경로 사용: 저장소 루트 기준 상대 경로를 씁니다.
• 전역 설치를 당연하게 여김: 필요한 도구와 버전을 사전 조건에 적습니다.
• 모든 언어 명령을 나열: 선택한 프로젝트 절차만 유지합니다.
• 오류를 숨기고 성공으로 기록: 실패 단계, 오류 요약과 해결 여부를 남깁니다.

✎7. 직접 실습

✎직접 실습

docs/run-guide.md만 보고 새 터미널에서 프로젝트를 실행하세요. 완료 기준은 시작 위치, 명령, 예상 결과, 종료 방법이 있고 다른 경로에서 시작해도 루트로 이동해 재현할 수 있는 것입니다.

?8. 이해 점검 질문 3개

?이해 점검

1. 성공 신호를 구체적으로 적어야 하는 이유는 무엇인가요?
2. 로컬 절대 경로 대신 무엇을 사용해야 하나요?
3. 프로젝트에 없는 실행 명령을 예시로 추가하면 어떤 문제가 생기나요?

■9. 핵심 요약

■핵심 요약

실행 가이드는 사전 조건부터 종료까지 실제로 재현한 절차입니다. 프로젝트 유형에 맞는 기존 명령만 사용하고 경로·버전·예상 결과를 명확히 씁니다.