1.6 KiB
1.6 KiB
cross-eval CLI 사용성 리팩토링 체크리스트
핵심 사용자 흐름
cross-eval init이후 무엇을 해야 하는지 분명하게 안내한다.cross-eval doctor를 언제 왜 써야 하는지 설명한다.cross-eval run실행 전 필요한 준비물이 명확하다.- 실행 후 결과가
.cross-eval/output아래에 저장된다는 점이 안내된다.
run 커맨드 이해도
--preset별 차이가 빠르게 비교 가능하다.--coder,--reviewer,--senior의 역할 차이가 설명된다.- config 기반 실행과 CLI 옵션 기반 실행의 관계가 명확하다.
- 어떤 옵션이 config를 override하는지 혼동 없이 이해할 수 있다.
예시 품질
- 대표 사용 예시가 실제 사용자 목적 중심으로 정리되어 있다.
- 예시가 너무 많아 산만하지 않고, 핵심 조합 위주로 압축되어 있다.
- 초보자용 기본 예시와 고급 사용 예시가 구분되어 있다.
- 예시만 복사해도 실제 실행 가능한 수준이다.
리팩토링 범위 통제
- 기존 명령 이름과 옵션 이름을 바꾸지 않는다.
- 기능 동작을 불필요하게 변경하지 않는다.
- 안내 문구 개선이 목적이지 새 기능 추가가 아님을 유지한다.
- plan 범위를 넘는 UI/기능 확장을 하지 않는다.
코드 품질
- 기존 테스트가 깨지지 않도록 한다.
- 도움말/문구 변경으로 인한 회귀를 확인한다.
- 문자열 변경이 실제 출력 흐름과 모순되지 않는다.
- 중복되거나 상충되는 설명이 생기지 않는다.