설정을 재현할 수 있는 README 작성 방법.
README는 검증된 요구사항으로 설정을 재현할 수 있게 해야 합니다. 확인한 지침과 제안 명령 또는 사용할 수 없는 설정을 구분하세요.
작업에 맞게 절차를 조정하세요.
저장소의 실제 스크립트, 선행 요건, 설정으로 설치와 첫 사용을 설명하세요. 검증된 명령과 제안 단계를 구분하고 예제에서 비밀값을 제외하며 테스트 경로를 명확히 제시하세요.
- 제공할 내용
- 검증된 프로젝트 동작과 설정 요구사항.
- 받을 결과
- 실행 가능하지만 검증이 필요한 단계가 담긴 프로젝트 문서.
입력과 결과를 확인하세요.
설명용 입력과 출력 · 실제 WebAct 실행이 아닌 학습용 예시
입력 항목 예시개
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
완성된 예시
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
이 입력을 프롬프트에 넣고 WebAct에 복사해 작업을 실행해 보세요. 결과는 설명용 예시와 다를 수 있습니다.
판단 기준과 문제 해결.
일반적으로 보이는 설치 명령을 README에 지어내도 되나요?
먼저 프로젝트를 확인하세요. 익숙한 명령도 실제 패키지 관리자, 잠금 파일, 빌드 절차에는 맞지 않을 수 있습니다.
README를 따라도 설정이 실패하는 이유는 무엇인가요?
실행 환경 버전, 필수 설정, 실제 스크립트를 비교하세요. 모호한 문제 해결 문단을 추가하기보다 누락된 단계를 재현하세요.
직접 준비한 자료로 시도하세요.
작업 프롬프트의 예시를 내 자료로 바꾸세요. 필요한 요구 사항은 유지하고 작업을 WebAct에 복사하세요.
작업 맞춤 설정 및 복사 ↑