CLI UX 검토은(는) 무엇을 하나요?
CLI를 고정된 평가 기준에 따라, 해당 도구를 한 번도 사용해본 적 없는 비개발자의 관점에서 감사합니다.
호출 시점
- "CLI UX 감사" / "내 CLI 검토" / "이 CLI 직관적인가요?"
- 모든 CLI 릴리스 전
- CLI 명령을 추가하거나 변경한 후
프레임
모든 명령 출력은 세 가지 질문에 답해야 합니다: 상황은 무엇인가? · 다음 단계는 무엇인가? · 무엇을 할 수 있는가?
품질 기준: 명령은 Codex가 세션을 종료하는 방식으로 끝나야 합니다 — 일반 상태 한 줄, 그 다음에 정확히 다음 명령어가 고유한 색상으로 표시되어 눈이 "이것을 입력하세요"에 즉시 고정됩니다.
평가 기준 (각 명령을 7개 항목 모두에 대해 점수 매기기)
- 다음 단계가 존재함. 모든 성공/종료 상태는 다음 명령어로 끝나거나, 명시적으로 "완료되었습니다."를 표시합니다. 어떤 명령도 조용히 멈추지 않습니다.
- 명령어가 색상으로 강조됨. 실행 가능한 명령어는 일관된 강조 색상(청록색 + 굵게)으로 렌더링됩니다. 절대 일반 텍스트나 리터럴 백틱으로 표시되지 않습니다.
- 내부 구현 노출 없음. 사용자 출력에 열거형 값, 상태 코드 또는 전문 용어가 없습니다. 사람이 읽을 수 있는 단어와 한 줄짜리 설명("dirty"는 "로컬 편집"으로 변경)을 사용합니다.
- 무음 중단 없음. 장기 실행 또는 stdio 명령은 TTY에서 자신을 알려 터미널이 멈춘 것처럼 보이지 않도록 합니다.
- 일관된 기본 요소. 하나의 글리프 세트, 하나의 행/테이블 도우미, 하나의 다음 단계 블록이 명령어 전체에서 공유되며, 명령어마다 새로 만들어지지 않습니다.
- 오류에 해결 방법 포함됨. 모든 오류는 정확히 해결하는 명령어 이름을 표시합니다.
- 첫 실행 가이드 제공. 빈 호출 또는 로그인되지 않은 상태에서 번호가 매겨진 빠른 시작 가이드를 보여줍니다.
실행 방법
- 모든 명령과 모든 출력 경로를 목록화합니다.
--help뿐만 아니라 소스 코드도 읽습니다. - 각 명령에 대해 성공 경로, 모든 오류 경로, 빈 상태를 살펴봅니다.
- 7가지 평가 항목에 따라 점수를 매깁니다. 각 발견 사항에 대해
파일:줄을 인용합니다. - 실패한 부분에 대해 정확한 문자열로 구체적인 전/후 예시를 작성합니다.
- 출력: 전반적인 문제점, 명령별 표, 순위가 매겨진 전/후 수정 사항, 실행 계획.
출력 형식
발견 문서: 요약 및 핵심 문제, 전반적인 문제점 표, 명령별 발견 사항, 각 수정 사항에 대한 전/후 예시, 실행 계획. 실제 출력 경로를 확인하지 않고 "괜찮아 보입니다"라고 절대 작성하지 마십시오.