Skip to content

Commit ac90039

Browse files
authored
[Docs] 문서 구조 정리 및 프로젝트 제목 통일 (#88)
* docs 정리 * 사용자 시나리오 문서 복구
1 parent 3072bcf commit ac90039

20 files changed

Lines changed: 474 additions & 170 deletions

.github/ISSUE_TEMPLATE/lightweight-task.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ body:
5353
label: Deliverable
5454
description: State what concrete output or change should exist when the task is done.
5555
placeholder: |
56-
- Add `docs/GitHub Project.md`
56+
- Add `docs/process/GitHub Project.md`
5757
- Capture the expected team workflow
5858
validations:
5959
required: true

AGENTS.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
- `Epic` for larger parent work
6969
- `Implementation Task` for `Engine` / `Domain` / `Application` / `Build` work
7070
- `Lightweight Task` for `Docs` / `Chore` / `Analysis` work
71-
- GitHub Project guidance is documented in `docs/GitHub Project.md`.
71+
- GitHub Project guidance is documented in `docs/process/GitHub Project.md`.
7272
- PR titles must follow `[Area] short summary`.
7373
- Allowed PR areas:
7474
- `Engine`
@@ -93,9 +93,10 @@
9393

9494
## Docs
9595
- After any changes to the project, ensure the documents remain consistent.
96-
- Architecture notes: `docs/프로젝트 구조.md`
97-
- Project workflow notes: `docs/GitHub Project.md`
98-
- Requirements and overview docs are under `docs/`.
96+
- Architecture notes: `docs/architecture/프로젝트 구조.md`
97+
- Project workflow notes: `docs/process/GitHub Project.md`
98+
- Requirements and overview docs are under `docs/product/`.
99+
- Use `docs/README.md` as the entry point for the document map.
99100

100101
## Review Priorities
101102
- Broken build or preset mismatch

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# SafeCrowd
2+
3+
SafeCrowd는 ECS 기반 군중 시뮬레이션과 안전 의사결정 지원을 목표로 하는 Qt 데스크톱 애플리케이션입니다.
4+
건물, 행사장, 대피 시나리오 같은 실제 운영 환경을 가정해 군중 흐름, 병목, 위험 징후를 비교 가능한 형태로 분석하는 것을 목표로 합니다.
5+
6+
## 핵심 목표
7+
8+
- 실제 공간 구조를 바탕으로 시뮬레이션 가능한 레이아웃을 구성한다.
9+
- 여러 운영 대안을 시나리오로 비교해 위험 차이를 확인한다.
10+
- Qt 기반 UI와 분리된 ECS 엔진 구조를 유지한다.
11+
12+
## 아키텍처
13+
14+
프로젝트는 `application -> domain -> engine` 계층을 유지합니다.
15+
16+
- `src/application`: Qt UI와 애플리케이션 조립
17+
- `src/domain`: SafeCrowd 도메인 로직
18+
- `src/engine`: 재사용 가능한 ECS 엔진
19+
20+
상세 구조는 [docs/architecture/프로젝트 구조.md](docs/architecture/프로젝트 구조.md)를 기준 문서로 사용합니다.
21+
22+
## 빠른 시작
23+
24+
전체 앱 빌드:
25+
26+
```powershell
27+
cmake --preset windows-debug
28+
cmake --build --preset build-debug
29+
ctest --preset test-debug
30+
```
31+
32+
Qt 앱 없이 빠르게 검증:
33+
34+
```powershell
35+
cmake --preset windows-debug-no-app
36+
cmake --build --preset build-engine-debug
37+
cmake --build --preset build-engine-domain-debug
38+
cmake --build --preset build-no-app-debug
39+
ctest --preset test-no-app-debug
40+
```
41+
42+
앱 빌드에는 `vcpkg.json``qtbase` 의존성이 필요합니다.
43+
44+
## 문서
45+
46+
- [docs/README.md](docs/README.md): 문서 전체 안내
47+
- [docs/product/개요서.md](docs/product/개요서.md): 프로젝트 개요와 이해당사자
48+
- [docs/product/사용자 시나리오.md](docs/product/사용자 시나리오.md): 대표 사용자 흐름
49+
- [docs/product/위험 정의.md](docs/product/위험 정의.md): 위험 및 사고 모델 정의
50+
- [docs/process/GitHub Project.md](docs/process/GitHub Project.md): 이슈, 프로젝트, PR 운영 규칙
51+
52+
## 기여 방식
53+
54+
기본 흐름은 `issue -> branch -> PR -> merge`입니다.
55+
문서와 저장소 운영 규칙은 [CONTRIBUTING.md](CONTRIBUTING.md)를 따릅니다.

docs/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# SafeCrowd 문서 안내
2+
3+
`docs/`는 기준 문서를 모아 두는 위치다. 진행 중 메모, 임시 TODO, 작업 상태 추적은 GitHub Issues와 Project에서 관리한다.
4+
5+
## 문서 구조
6+
7+
- `architecture/`: 계층 구조, 책임, 디렉터리 규칙 같은 오래 유지할 설계 기준
8+
- `process/`: GitHub Project, 이슈/PR 규칙 같은 협업 절차
9+
- `product/`: 개요, 사용자 시나리오, 위험 정의, 백로그 같은 제품 요구와 범위
10+
- `references/`: 외부 조사 자료와 튜토리얼. 기준 문서의 보조 근거로만 사용
11+
- `제출용/`: 학교 제출 산출물. 저장소 운영 기준 문서와 분리해 보관
12+
13+
## 시작점
14+
15+
- [architecture/프로젝트 구조.md](architecture/프로젝트 구조.md)
16+
- [process/GitHub Project.md](process/GitHub Project.md)
17+
- [product/개요서.md](product/개요서.md)
18+
- [product/사용자 시나리오.md](product/사용자 시나리오.md)
19+
- [product/위험 정의.md](product/위험 정의.md)
20+
- [product/Product Backlog.md](product/Product Backlog.md)
21+
22+
## 유지 규칙
23+
24+
- 한 사실은 한 문서만 기준으로 삼는다.
25+
- 구조 변경은 `architecture/`, 협업 규칙 변경은 `process/`, 요구 변경은 `product/`를 먼저 갱신한다.
26+
- 외부 링크, 조사 메모, 튜토리얼은 `references/`로 보낸다.
27+
- 제출 양식과 산출물은 `제출용/`에 두고 기준 문서처럼 직접 참조하지 않는다.
28+
- 이 저장소는 별도 `adr/` 폴더를 두지 않는다. 구조 결정은 `architecture/프로젝트 구조.md`에, 협업 규칙 결정은 `process/GitHub Project.md``CONTRIBUTING.md`에 반영한다.
File renamed without changes.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Product Backlog
22

33
## Project Name
4-
**SafeCrowd: ECS 게임 엔진 기반 군중 행동 시뮬레이션 및 의사결정 지원 시스템**
4+
**SafeCrowd: 군중 안전 시뮬레이터**
55

66
02조
77
202002520 은민수
@@ -21,7 +21,7 @@
2121

2222
| 항목 | 내용 |
2323
| --- | --- |
24-
| Project Name | SafeCrowd: ECS 게임 엔진 기반 군중 행동 시뮬레이션 및 의사결정 지원 시스템 |
24+
| Project Name | SafeCrowd: 군중 안전 시뮬레이터 |
2525
| Version | v1.0 |
2626
| 작성일 / 수정일 | 2026/04/01 / 2026/04/03 |
2727
| Product Owner (PO) | 02조 공동 |
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SafeCrowd 개요
22
## SafeCrowd란?
3-
ECS 게임 엔진 기반 군중 행동 시뮬레이션 및 의사 결정 지원 시스템
3+
SafeCrowd: 군중 안전 시뮬레이터
44

55
## 대상 이해당사자 (stakeholder)
66
- 건물 관리자 및 안전 관리자
File renamed without changes.

0 commit comments

Comments
 (0)