Files

2.3 KiB

문서 편집 기준

첫 화면

README는 공통 표지, 프로젝트 제목, 기능·결과 소개, 기준판·환경·접근 범위, 시작하기·사용 안내·문서 둘러보기 순서로 구성합니다. 표지는 1200×300 비율을 유지합니다. 기존 로고와 과거 표지는 삭제하거나 덮어쓰지 않습니다.

본문

H2는 살펴보기 → 시작하기 → 사용하기 → 확인된 범위 → 문서와 지원 → 이용 조건 순서로 둡니다. 프로젝트 고유 기능은 H3로 구분합니다. 자료 저장소의 시작하기는 파일 확인과 복원을 설명하며 프로그램 설치 절차를 만들지 않습니다.

짧고 사실적인 한국어를 씁니다. 기능, 실행 순서와 결과를 직접 설명하고 홍보 문구·이모지·상태 배지는 사용하지 않습니다. 안전·권리·자료 전송의 필요한 설명은 줄이기 위해 삭제하지 않습니다.

화면은 중앙 720px, 문서 결과는 중앙 480px를 기본으로 하며 원본 비율과 확대 링크를 유지합니다. 캡션에 실제 화면·설명용 응답·버전·촬영 근거를 구별합니다. 구판 예시는 접을 수 있지만 첫 실행과 중요한 경고는 펼쳐 둡니다.

명령은 실행 위치를 먼저 설명하고 bat·powershell·sh·text 언어를 구별합니다. 명령 뒤에는 결과나 다음 단계를 씁니다. 파일 구조와 설명용 예시는 실행 명령으로 표시하지 않습니다.

확인된 범위는 확인 항목·상태·근거의 세 열로 정리합니다. 배포판·후보·구판과 통과·실패·미실행을 구별합니다. 코드나 파일 검사만으로 실제 계정 실행·사용자 환경·내용 품질까지 통과했다고 쓰지 않습니다.

문서 목차

문서 목차는 프로젝트 문서 제목, 프로젝트 소개·시작하기·사용 안내 링크, 기준판 안내, 사용하기 → 확인된 범위 → 개발과 구조 → 이용 조건 순서로 구성합니다. 표의 열 이름은 필요한 안내·문서로 맞춥니다.

변경 후 확인

기존 자료·라이선스·기능과 파일 권한을 보존합니다. 상대 링크와 앵커, 판본과 실행 명령, 자산 크기를 확인하고 넓은 화면과 좁은 화면에서 실제 배치를 읽습니다. 정식 GitHub 렌더와 로컬 미리보기의 확인 범위는 따로 기록합니다.