2.1 KiB
2.1 KiB
프로젝트 작업 규칙
작업 완료 후 커밋
- 매 작업을 완료할 때 관련 검증을 수행한 뒤 해당 작업의 변경 사항을 반드시 커밋한다.
- 별도의 커밋 요청이나 확인을 기다리지 않는다. 사용자가 명시적으로 커밋하지 말라고 요청한 경우는 예외로 한다.
- 해당 작업과 무관한 기존 변경 사항은 커밋에 포함하지 않는다.
- 완료 보고에 커밋 해시와 검증 결과를 명시한다. 푸시는 사용자가 요청한 경우에 수행한다.
UI 문구 최소화
화면 문구는 사용자의 행동과 판단에 필요한 정보만 표시한다.
허용
- 버튼·메뉴·입력 항목의 기능을 식별하는 이름
- 스킬·아이템의 실제 효과, 비용, 지속시간, 사용 조건
- 현재 상태, 작업 결과, 오류와 해결 방법
- 조작에 반드시 필요한 안내
금지
- 기능을 소개하거나 장점을 홍보하는 문구
- 제목·버튼·화면에서 이미 알 수 있는 내용을 반복하는 설명
- 분위기를 채우기 위한 부제, 슬로건, 환영 문구
- 구현 방식, 기술 스택, 프로토타입 제작 과정에 관한 설명
- 요청하지 않은 도움말, 팁, 예시 문구
작성 기준
- 문구를 삭제해도 사용자가 기능과 결과를 이해할 수 있으면 삭제한다.
- 버튼은 행동 이름으로 작성한다. 예: "저장", "장착", "전투 시작".
- 효과는 실제 동작을 짧고 정확하게 표현한다. 예: "강력한 공격으로 적을 압도합니다" 대신 "적 1명에게 피해 120".
- 예시 수치를 그대로 사용하지 말고, 실제 구현에 맞는 수치와 조건만 표시한다. 수치와 조건을 임의로 만들지 않는다.
- 상세 설명이 꼭 필요하면 해당 조작 근처나 도움말에 배치한다.
- 접근성에 필요한 이름과 레이블은 유지한다.
완료 전 검토
- 새로 추가하거나 수정한 모든 화면 문구를 검토한다.
- 행동·효과·조건·상태·오류 이해에 기여하지 않는 문구를 제거한다.