코딩 수업 결과물 README에 무엇을 적으면 좋을까요

무엇을 하는지와 실행 방법을 먼저 설명합니다

README는 방문자가 프로젝트 목적·사용법·도움받을 경로를 이해하도록 하는 문서입니다. 수강 과정명과 기술 이름만 나열하기보다 본인이 만든 결과가 어떤 문제를 다루는지 설명합니다. 실제 하지 않은 운영 성과나 고객 사례는 넣지 않습니다.

다른 사람이 시작할 순서대로 씁니다

프로젝트 목적과 사용 범위, 필요한 환경·도구, 실행 순서, 기대 화면 또는 예제 입력·출력을 정리합니다. 원본 수업 예제에서 바꾼 부분과 아직 동작하지 않는 부분도 구분합니다. 비밀키가 필요한 경우 값 자체를 쓰지 말고 안전한 설정 방법을 설명합니다.

설명은 직접 확인한 범위로 제한합니다

예를 들어 본인 기기에서만 실행했다면 그 환경을 적고 다른 운영체제에서도 검증했다고 쓰지 않습니다. 외부 자료·코드·이미지는 출처와 권리 조건을 남깁니다. 기관이 과제 공개를 허용하는지도 확인합니다.

문서를 보고 재현할 수 있는지 점검합니다

필요한 파일과 상대 링크가 열리는지 확인하고 실행 설명과 실제 결과를 대조합니다. 이 원고에서는 코드를 실행하거나 README를 저장소에 게시하지 않습니다. 작업 결과를 공개하지 않았다면 포트폴리오 배포 완료라고 표현하지 않습니다.

조건별로 갈리는 지점

결제 전 확인 목록

• 무엇을 하는지와 실행 방법을 먼저 설명합니다
• 다른 사람이 시작할 순서대로 씁니다
• 설명은 직접 확인한 범위로 제한합니다
• 문서를 보고 재현할 수 있는지 점검합니다

4개 중 0개 확인 · 체크 상태는 페이지를 떠나면 초기화됩니다.

어디서 확인할 수 있는가

아래는 기관 정보를 직접 확인할 수 있는 공식 경로입니다. 각 과정과 종목의 상세 공지를 확인하세요. 본문의 선택 기준과 예시는 배움결이 작성했습니다.

• GitHub 공식 문서 현재 본문 ↗