Files
portfolio-hub/docs/SRS/index.md
T

2.4 KiB

PortfolioHub SRS Index

이 문서는 docs/SRS/ 하위 requirement 문서의 운영 기준과 등록 현황을 관리한다.

Requirement 작성 규칙

  • Requirement 하나당 문서 하나를 사용한다.
  • 새 requirement ID의 source of truth는 이 문서의 Next Requirement ID다.
  • Type 분류는 주된 사용자/외부 계약을 기준으로 결정한다.
    • Interface: API, CLI, UI 등 사용자가 직접 조작하거나 호출하는 방식
    • Data: 저장 구조, 스키마, 데이터 형식 자체가 핵심 제약인 경우
    • Exception & Error Handling: 오류 응답, 복구, 재시도 전략이 핵심인 경우
    • 그 외는 관련 운영 기준에 따라 적절한 Type을 선택한다.
  • 각 requirement는 최소한 Status, Type, Priority, Owner, Intent, Requirement, Acceptance Criteria, Impacted Area, Change Log를 포함해야 한다.
  • 새 requirement가 추가되면 Requirement Register와 Next Requirement ID를 함께 갱신한다.
  • 최근 변경 요약은 최신 항목을 위에 두고 최대 5건만 유지한다.

Next Requirement ID

  • REQ-002

Requirement Register

REQ ID Title Type Status Priority Owner File
REQ-001 포트폴리오 댓글형 메모 이력 지원 Interface Approved Medium Justin docs/SRS/Interface/REQ-001_portfolio-comment-history.md

Recent Change Log Summary

  • 2026-04-10 — REQ-001 상태를 Approved로 전환했다.
  • 2026-04-10 — REQ-001에 권한, 오류 응답, 정렬 규칙, testable acceptance criteria를 보강했다.
  • 2026-04-10 — REQ-001 초안을 추가해 포트폴리오 댓글형 메모 이력의 API/CLI 계약과 별도 테이블 저장 요구를 정의했다.

Status Transition Evidence

  • Proposed → Approved: Owner가 지정되고 requirement 문서 리뷰가 완료되며 acceptance criteria가 누락 없이 검토되어야 한다.
  • Approved → Implemented: 구현 코드가 병합되고 관련 문서 및 테스트 경로가 requirement 또는 traceability matrix에 연결되어야 한다.
  • Implemented → Verified: 자동 테스트 또는 수동 검증 evidence가 확인되어야 한다.
  • Verified → Released: 배포 또는 릴리스 노트 반영 evidence가 확인되어야 한다.
  • Requirement files: docs/SRS/<Type>/REQ-XXX_<slug>.md
  • Traceability matrix: docs/SRS/traceability-matrix.md