Specful ADR 기록하기
ADR은 지속 가능한 결정이 내려진 이유(영향력, 신뢰할 수 있는 대안, 결과)를 기록합니다. 이는 요구사항(소프트웨어가 해야 할 일)이나 설계(시스템 작동 방식)가 아닙니다. 변경 사항이 무엇 또는 어떻게에 관한 것이라면 specful-requirement 또는 specful-design을 대신 로드하세요. 결정 수준을 유지하세요: 작업 순서, 파일 목록, 진행 상황 메모는 포함하지 마십시오.
워크플로
docs/adr/디렉터리와 그 인덱스를 읽어 번호, 상태 및 이미 기록된 결정을 확인합니다. 기존에 수락된 ADR과 모순되는 새로운 ADR은 조용히 의견을 달리하는 것이 아니라 이를 대체합니다.specful new adr --title <TITLE>로 스캐폴딩합니다. 식별자를 수동으로 할당하지 마십시오. 명령어가 카운터를 소유합니다.- 플레이스홀더를 완성합니다. 결정을 현재 시제로 명시합니다. 신뢰할 수 있는 대안을 선호하는 답변을 위한 허수아비가 아닌 정직하게 제시합니다. 부정적 결과를 긍정적 결과와 동일한 주의로 기록합니다. 신뢰할 수 있는 대안이나 단점이 없는 ADR은 결정 기록이 아닌 광고입니다.
- 수명 주기는 유지 관리자의 소유입니다. 새 기록은
proposed로 시작하며, 유지 관리자만이accepted,rejected또는supersedes를 수행할 수 있습니다. specful index를 실행한 다음specful validate를 실행합니다. 변경 사항과 함께 재생성된 뷰를 커밋합니다. 채택하는 저장소가 실질적인 검토를 요구하거나 사용자가 요청하는 경우specful-review를 사용하십시오.
전체 ADR 프로필 및 필드별 가이드는 https://unkos-dev.github.io/specful/에서 확인할 수 있습니다.