refactor docs into technical specs

This commit is contained in:
2026-04-13 23:20:25 +09:00
parent f3c870553d
commit 256b3709a0
19 changed files with 1713 additions and 2087 deletions
@@ -30,7 +30,7 @@
7. Given 존재하지 않는 `portfolio_id` 또는 `comment_id`가 요청에 포함될 때, When 사용자가 API 또는 CLI로 조회·수정·삭제를 시도하면, Then 시스템은 `404` 응답 또는 이에 대응하는 CLI 오류를 반환하고 새로운 메모를 생성하거나 기존 데이터를 변경하지 않아야 한다.
## Impacted Area
- Docs: `docs/portfoliohub-spec.md`, `docs/api-examples.md`, `docs/db-schema-spec.md`, `docs/SRS/index.md`
- Docs: `docs/technical/api-contracts.md`, `docs/technical/persistence-and-migrations.md`, `docs/SRS/index.md`
- Modules: `app/api/portfolios.py`, `app/cli/commands/portfolio.py`, `app/schemas/portfolio.py`, `app/services/portfolio_service.py`, `app/repositories/portfolio_repository.py`, `app/repositories/postgres.py`, `migrations/versions/*`
- Tests: `tests/test_app.py`, `tests/test_cli.py`, `tests/test_domain_services.py`
@@ -41,6 +41,37 @@
## Change Log
### CHG-20260413-04
- Date: 2026-04-13
- Author: GitHub Copilot
#### Change Summary
- 삭제 예정인 상위 docs 경로를 technical 문서 경로로 정리했다.
#### Intent
- 구현 추적 문서가 삭제 후에도 유효한 참조를 유지하도록 하기 위함이다.
#### Acceptance Criteria Delta
- Added:
- 없음
- Updated:
- Impacted Area의 docs 경로를 `docs/technical/` 기준으로 갱신
- Removed:
- 없음
#### Impacted Area Delta
- Docs:
- `docs/SRS/Interface/REQ-001_portfolio-comment-history.md`
- `docs/technical/api-contracts.md`
- `docs/technical/persistence-and-migrations.md`
- Modules:
- 없음
- Tests:
- 없음
#### Validation Plan
- 삭제 대상 문서 제거 후에도 REQ-001의 구현 추적 문서 링크가 모두 유효한지 확인한다.
### CHG-20260410-03
- Date: 2026-04-10
- Author: GitHub Copilot
@@ -126,9 +157,8 @@
#### Impacted Area Delta
- Docs:
- portfoliohub-spec.md
- api-examples.md
- db-schema-spec.md
- docs/technical/api-contracts.md
- docs/technical/persistence-and-migrations.md
- `docs/SRS/index.md`
- Modules:
- portfolios.py
@@ -35,7 +35,7 @@
10. Given 소비 서비스가 `includeTags=["grade:A", "grade:B"]`, `excludeTags=["blacklist:trade"]` 조건으로 목록 조회를 요청한 상태, When 태그 필터 검색을 수행하면, Then 시스템은 포함 조건을 만족하고 제외 조건을 만족하지 않는 항목만 반환해야 한다.
## Impacted Area
- Docs: `docs/portfoliohub-spec.md`, `docs/api-examples.md`, `docs/db-schema-spec.md`, `docs/SRS/index.md`, `docs/SRS/traceability-matrix.md`
- Docs: `docs/technical/api-contracts.md`, `docs/technical/persistence-and-migrations.md`, `docs/SRS/index.md`, `docs/SRS/traceability-matrix.md`
- Modules: `app/api/portfolios.py`, `app/cli/commands/portfolio.py`, `app/schemas/portfolio.py`, `app/services/portfolio_service.py`, `app/repositories/portfolio_repository.py`, `app/repositories/postgres.py`, `app/domain/models.py`, `migrations/versions/*`
- Tests: `tests/test_app.py`, `tests/test_cli.py`, `tests/test_domain_services.py`
@@ -47,6 +47,37 @@
## Change Log
### CHG-20260413-05
- Date: 2026-04-13
- Author: GitHub Copilot
#### Change Summary
- 삭제 예정인 상위 docs 경로를 technical 문서 경로로 정리했다.
#### Intent
- 태그 기능 requirement가 삭제 후에도 유효한 구현 추적 문서를 가리키도록 유지하기 위함이다.
#### Acceptance Criteria Delta
- Added:
- 없음
- Updated:
- Impacted Area의 docs 경로를 `docs/technical/` 기준으로 갱신
- Removed:
- 없음
#### Impacted Area Delta
- Docs:
- `docs/SRS/Interface/REQ-002_portfolio-tagging-and-search.md`
- `docs/technical/api-contracts.md`
- `docs/technical/persistence-and-migrations.md`
- Modules:
- 없음
- Tests:
- 없음
#### Validation Plan
- 삭제 대상 문서 제거 후에도 REQ-002의 docs 추적 링크가 모두 유효한지 확인한다.
### CHG-20260413-04
- Date: 2026-04-13
- Author: GitHub Copilot
@@ -165,9 +196,8 @@
#### Impacted Area Delta
- Docs:
- portfoliohub-spec.md
- api-examples.md
- db-schema-spec.md
- docs/technical/api-contracts.md
- docs/technical/persistence-and-migrations.md
- index.md
- traceability-matrix.md
- Modules: