유즈케이스
사용자가 무엇을 이루려고 AriadneNSD를 쓰는지를 유즈케이스로 적습니다. 요구사항 명세가 기능의 목록이라면, 이 문서는 그 기능들이 이어지는 흐름입니다. 흐름은 그대로 인수 테스트의 시나리오가 됩니다.
읽는 법
- 유즈케이스는 사용자 목표 수준으로, 기본 흐름과 예외 흐름 몇 줄로 씁니다. 실패가 비싼 흐름(UC-02 열기, UC-06 저장, UC-07 노트에 삽입해 보이기)만 최소 보장 · 성공 보장 · 확장까지 갖춘 자세한 형식(Cockburn의 fully dressed)으로 씁니다(DR-0014). 세부 규칙(어떤 키, 어떤 모습)은 UX 설계(02-interaction-rules)에 있고 여기서는 되풀이하지 않습니다.
- 각 유즈케이스 끝의 “요구사항”은 그 흐름이 기대는 요구사항의 ID입니다. 우선순위(
P0…)는 요구사항 쪽에 있습니다.- 흐름의 번호에 붙은
a,b는 그 단계에서 분기하는 예외 흐름(자세한 형식에서는 “확장”)입니다(예: 3a는 3단계의 예외).'가 붙은 것은 같은 단계를 다른 수단으로 하는 기술 변형입니다.
1. 액터
| 액터 | 누구 | 하는 일 |
|---|---|---|
| 작성자 | 설계 문서를 쓰는 실무자(01-requirements) | 다이어그램을 만들고 편집하고 저장하고 공유한다 |
| 독자 | 문서 · 노트 · 저장소에서 그림을 보는 사람. AriadneNSD가 없을 수 있다 | 저장된 그림을 본다 |
| 호스트 플랫폼 | Obsidian, Google Drive, 브라우저, OS | 파일을 보관하고, 그림을 미리 보여 주고, AriadneNSD를 호출한다 |
2. 유즈케이스 다이어그램
flowchart LR author["«actor»<br/>작성자"] reader["«actor»<br/>독자"] host["«actor»<br/>호스트 플랫폼"] subgraph sys["AriadneNSD"] uc01(["UC-01 새 다이어그램을 만든다"]) uc02(["UC-02 다이어그램을 연다"]) uc03(["UC-03 블록을 편집한다"]) uc04(["UC-04 구조를 나눈다"]) uc05(["UC-05 큰 다이어그램을 훑어본다"]) uc06(["UC-06 저장한다"]) uc07(["UC-07 노트에 다이어그램을 삽입해 보인다"]) uc08(["UC-08 공유하고 내보낸다"]) uc09(["UC-09 그림의 모양을 정한다"]) uc10(["UC-10 문제를 알린다"]) end author --- uc01 & uc02 & uc03 & uc04 & uc05 & uc06 & uc07 & uc08 & uc09 & uc10 uc07 --- reader uc08 --- reader uc02 --- host uc06 --- host uc07 -.«include».-> uc03 uc07 -.«include».-> uc06 uc01 -.«include».-> uc03
범례 (Mermaid에 UML 유즈케이스 다이어그램이 없어 flowchart로 그림)
- 사각형 «actor» = 액터, 둥근 칸 = 유즈케이스, 큰 테두리 = 시스템 경계.
- 실선(화살표 없음): 액터가 그 유즈케이스에 참여한다(UML의 연관). 왼쪽이 주 액터, 오른쪽이 보조 액터.
- 점선 «include»: 화살표 꼬리의 유즈케이스가 머리의 유즈케이스를 흐름 안에 포함한다.
3. 목록
MVP 열은 MVP 범위(웹의 P0)에서 그 유즈케이스의 기본 흐름이 되는지입니다.
| ID | 유즈케이스 | 주 액터 | 형식 | MVP |
|---|---|---|---|---|
| UC-01 | 새 다이어그램을 만든다 | 작성자 | 가볍게 | 됨 |
| UC-02 | 다이어그램을 연다 | 작성자 | 자세히 | 됨(웹의 로컬 파일) |
| UC-03 | 블록을 편집한다 | 작성자 | 가볍게 | 됨(블록 6종, 드래그 앤 드롭 포함) |
| UC-04 | 구조를 나눈다 | 작성자 | 가볍게 | 아님(P1) |
| UC-05 | 큰 다이어그램을 훑어본다 | 작성자 | 가볍게 | 확대 · 이동만 |
| UC-06 | 저장한다 | 작성자 | 자세히 | 됨 |
| UC-07 | 노트에 다이어그램을 삽입해 보인다 | 작성자 | 자세히 | 아님(Obsidian) |
| UC-08 | 공유하고 내보낸다 | 작성자 | 가볍게 | PNG 내보내기. 공유 URL과 보기 모드(P1)도 웹에 있음 |
| UC-09 | 그림의 모양을 정한다 | 작성자 | 가볍게 | 아님(P1). 기본 스타일만 MVP |
| UC-10 | 문제를 알린다 | 작성자 | 가볍게 | 아님(P3) |
4. 유즈케이스
UC-01 새 다이어그램을 만든다
- 액터: 작성자
- 사전 조건: AriadneNSD를 열 수 있다(웹 페이지, 데스크톱 앱, Obsidian 플러그인, Drive 연동 가운데 하나)
기본 흐름
- 작성자가 새 다이어그램을 만든다.
- 편집기가 다이어그램 하나와 빈 블록 하나가 든 새 문서를 연다.
- 작성자가 블록을 편집한다 → UC-03
예외 흐름
- 1a. Obsidian에서 노트 안에 바로 삽입하려면 → UC-07
- 1b. Obsidian 파일 탐색기의 컨텍스트 메뉴에서 만들면 노트에 삽입하지 않고 파일만 생긴다
- 1c. Google Drive의 “새로 만들기”에서 만들면 Drive에 파일이 생긴다
요구사항: R-ALL-03, R-OBS-08, R-GD-02, R-NFR-01
UC-02 다이어그램을 연다
자세한 형식
실패가 비싼 흐름이라 자세한 형식으로 씁니다(DR-0014).
| 항목 | 내용 |
|---|---|
| 범위 | AriadneNSD (모든 배포 대상) |
| 수준 | 사용자 목표 |
| 주 액터 | 작성자 |
| 보조 액터 | 호스트 플랫폼 (디스크, 볼트, Drive, 브라우저) |
| 이해관계자와 관심 | 작성자: 저장할 때의 모습 그대로 이어서 편집한다. 다른 배포 대상에서 만든 파일도 열린다. 파일의 주인(작성자, 팀의 저장소): 열기만 해서는 파일이 바뀌지 않는다 |
| 사전 조건 | AriadneNSD가 저장한 파일(.ns 또는 .ns.svg)이나 공유 URL이 있다 |
| 최소 보장 | 열다가 실패해도 원본 파일은 바뀌지 않는다. 실패한 이유를 알린다 |
| 성공 보장 | 편집기에 저장할 때와 같은 내용과 뷰 상태(접힘, 펴 보인 호출 블록)가 보인다. 그림은 파일의 그림 부분이 아니라 모델에서 다시 그린 것이다 |
| 트리거 | 작성자가 파일을 연다 |
기본 성공 시나리오
- 작성자가 파일을 선택한다.
- 호스트 플랫폼이 파일의 내용을 편집기에 전달한다.
- 편집기가 파일 안의 모델만 읽는다.
- 편집기가 모델에서 그림을 다시 그리고, 저장할 때의 뷰 상태대로 보인다.
- 작성자가 블록을 편집한다 → UC-03
확장
- 1a. Obsidian에서 일반
.svg를 열면 AriadneNSD가 아니라 Obsidian의 기본 동작으로 열린다 - 1b. Obsidian에서 이름이 바뀌어
.ns가 빠진 파일도 모델이 들어 있으면 편집 메뉴가 생긴다 - 1c. 공유 URL을 열면 보기 모드로 시작하고, 버튼 하나로 편집으로 넘어간다 → 3. 공유 URL과 보기 모드
- 1e. 다른 AI가 준 모델 JSON이나 공유 링크를 붙여넣는다(웹: 편집 화면에 붙여넣기, 또는 파일 › 붙여넣은 JSON으로 열기…): 새 문서로 열지 묻고, 편집할 수 있는 새 문서로 연다 → 3.2 붙여넣은 문서
- 1d. 같은 파일이 이미 다른 창이나 탭에 열려 있다: 웹은 나중에 연 탭에 알리고 보기만 하게 한다 → 2. 로컬 백업과 자동 저장. 다른 배포 대상은 미결정(6장)
- 3a. 모델이 없거나 깨진 파일: 편집할 수 없다고 알리고 끝난다. 그림을 거꾸로 읽어 모델을 만들지 않는다
- 3b. 옛 형식 버전의 파일: 지금 형식으로 바꿔 읽는다. 원본이 언제 새 형식이 되는지는 미결정(6장). 프로토타입이 저장한
version: 0파일은 바꿔 읽지 않고 3a와 같이 다룬다 → ADR-0035 - 3c. 지금보다 새 형식 버전의 파일: 편집할 수 없다고 알리고 앱 업데이트를 안내한다
- 3d. 다른 도구로 그림 부분만 수정한 파일: 그림이 모델과 달라졌다고 알린다
기술 변형
- 1’. 웹 · 데스크톱은 파일 열기, Obsidian은 파일 탐색기, Drive는 “AriadneNSD로 열기”, 데스크톱은
.ns더블클릭으로도
빈도: 편집을 시작할 때마다
요구사항: R-WEB-02, R-ALL-02, R-DSK-01, R-DSK-02, R-DSK-03, R-DSK-04, R-OBS-05, R-OBS-06, R-OBS-09, R-GD-01, R-WEB-05, R-WEB-06, R-WEB-11, R-FMT-02, R-FMT-05, R-FMT-06, R-FMT-09, R-NFR-02
UC-03 블록을 편집한다
- 액터: 작성자
- 사전 조건: 다이어그램이 편집기에 열려 있다(UC-01, UC-02)
기본 흐름
- 작성자가 블록을 하나 또는 여럿 선택한다.
- 작성자가 블록을 삽입하거나, 삭제하거나, 텍스트를 편집하거나, 제어 블록으로 감싸거나 푼다.
- 편집기가 그림을 다시 그린다. 블록의 크기와 분기의 너비는 텍스트에 맞춰 자동으로 정해진다.
- 작성자가 마음에 들지 않으면 실행 취소한다.
예외 흐름
- 1a. 다른 깊이의 블록을 함께 선택하면, 둘을 함께 품는 가장 가까운 범위로 넓혀 선택한다
- 2a. 구조가 깨지는 편집(예: 반복의 본문을 비우기)은 일어나지 않는다. 빈 분기는 빈 블록으로 채워진다
- 2b. 키보드만으로도 1~4를 모두 할 수 있다
- 2c. 드래그 앤 드롭, 복사 · 붙여넣기로 블록을 이동한다
- 2d. If의 분기를 바꾸거나, Case의 분기를 추가하고 빼고 순서를 바꾼다
- 2e. 쓰는 법이나 키를 모르면 도움말을 연다(→ R-EDIT-21)
요구사항: R-EDIT-01, R-EDIT-02, R-EDIT-03, R-EDIT-04, R-EDIT-05, R-EDIT-06, R-EDIT-07, R-EDIT-09, R-EDIT-10, R-EDIT-11, R-EDIT-12, R-EDIT-21, R-EDIT-22, R-EDIT-24, R-BLK-01, R-BLK-02, R-BLK-03, R-BLK-04, R-BLK-05, R-BLK-06, R-LAY-01, R-LAY-02, R-NFR-01, R-NFR-03
UC-04 구조를 나눈다
- 액터: 작성자
- 사전 조건: 다이어그램이 편집기에 열려 있다
기본 흐름
- 작성자가 따로 떼어 낼 블록들을 선택한다.
- 작성자가 “새 Method로 빼기”를 한다.
- 선택한 블록들이 새 Method 다이어그램이 되고, 그 자리에는 그 Method를 호출하는 호출 블록이 남는다.
- 작성자가 Method 헤더의 이름을 편집하면, 그 Method를 호출하는 호출 블록이 모두 따라 바뀐다.
예외 흐름
- 1a. 처음부터 Event나 Method 다이어그램을 새로 만들어 나란히 둔다
- 2a. 거꾸로, 호출 블록을 풀어 Method의 블록들로 바꾼다
- 3a. 호출할 것이 문서에 없으면(라이브러리 함수 등) 이름을 적어 호출한다. 나중에 그 이름의 Method를 그리기로 하면 그 호출 블록에서 Method를 만든다
- 4a. 호출 블록이 호출하던 Method를 삭제하면 그 호출 블록은 보이던 이름을 적은 호출 블록이 된다
요구사항: R-EDIT-18, R-EDIT-19, R-EDIT-08, R-BLK-10, R-BLK-11, R-BLK-07, R-BLK-08, R-EDIT-26
UC-05 큰 다이어그램을 훑어본다
- 액터: 작성자
- 사전 조건: 한 화면에 다 보이지 않는 다이어그램이 열려 있다
기본 흐름
- 작성자가 확대 · 축소하고 화면을 옮긴다.
- 작성자가 지금 보지 않을 제어 블록이나 분기를 접는다.
- 작성자가 여러 블록을 묶어 이름을 붙인 접기 영역으로 접는다.
- 작성자가 호출 블록을 펴서 그 자리에서 Method의 블록을 본다.
예외 흐름
- 2a. 모두 접기 · 모두 펴기 · 깊이 n까지 펴기(
P2) - 4a. 펴 보인 호출 블록 안에서도 접기 영역을 만든다. 그 자리에만 있고 Method에는 없다
요구사항: R-LAY-03, R-EDIT-13, R-EDIT-14, R-EDIT-15, R-EDIT-16, R-EDIT-17
UC-06 저장한다
자세한 형식
실패가 비싼 흐름이라 자세한 형식으로 씁니다(DR-0014).
| 항목 | 내용 |
|---|---|
| 범위 | AriadneNSD (모든 배포 대상) |
| 수준 | 사용자 목표 |
| 주 액터 | 작성자 |
| 보조 액터 | 호스트 플랫폼 (디스크, 볼트, Drive, 브라우저) |
| 이해관계자와 관심 | 작성자: 편집한 것을 잃지 않는다. 독자: AriadneNSD 없이도 어디서나 그림이 보인다. 팀의 저장소(git): 같은 내용이면 같은 파일이라 쓸데없는 diff가 생기지 않는다 |
| 사전 조건 | 편집기에 문서가 열려 있다 |
| 최소 보장 | 저장에 실패해도 편집기의 내용은 그대로 남고, 실패했다고 알린다. 원본 파일이 온전히 남는지는 미결정(6장) |
| 성공 보장 | 파일은 유효한 SVG 1.1이고, 모델(형식 버전 포함)과 그림과 쓰인 문자의 글꼴 서브셋이 들어 있다. 그림의 색은 문서의 테마다. 같은 내용과 같은 뷰 상태는 어디서 저장해도 같은 바이트다. “저장 안 됨” 표시가 사라진다 |
| 트리거 | 작성자가 저장한다 |
기본 성공 시나리오
- 작성자가 저장한다.
- 편집기가 모델과 뷰 상태로 그림을 다시 그리고, 모델과 그림과 글꼴 서브셋을 SVG 파일 하나로 만든다.
- 호스트 플랫폼이 원래 파일에 쓴다.
- 편집기가 “저장 안 됨” 표시를 지운다.
확장
- 1a. 다른 이름으로 저장한다: 3에서 새 파일에 쓴다
- 1b. 웹에서는 저장하기 전에도 작성 중인 내용이 브라우저에 로컬 백업으로 남아, 새로고침해도 복원된다
- 2a. 블록 텍스트에 어떤 문자가 있어도(
]]>포함) 파일이 깨지지 않는다 - 3a. 원래 파일에 덮어쓰지 못하는 브라우저 → 06-web에서 정함
- 3b. 쓰기에 실패한다(권한, 디스크, 네트워크): 실패했다고 알린다. 다시 시도하게 하는지, 다른 이름으로 저장하게 하는지는 미결정(6장)
- 3c. 연 뒤에 파일이 다른 곳에서 바뀌었다(다른 창, Obsidian 동기화, Drive의 다른 사용자): 미결정(6장)
기술 변형
- 3’. 웹 · 데스크톱은 디스크, Obsidian은 볼트, Drive는 Drive의 원래 파일
빈도: 편집하는 동안 자주. 자동 저장이 있어 더 자주
요구사항: R-FMT-01, R-FMT-02, R-FMT-03, R-FMT-04, R-FMT-07, R-FMT-08, R-WEB-02, R-DSK-01, R-GD-03, R-WEB-03, R-EXP-04, R-NFR-02
UC-07 노트에 다이어그램을 삽입해 보인다
자세한 형식
실패가 비싼 흐름이라 자세한 형식으로 씁니다(DR-0014).
| 항목 | 내용 |
|---|---|
| 범위 | AriadneNSD Obsidian 플러그인 |
| 수준 | 사용자 목표 |
| 주 액터 | 작성자 |
| 보조 액터 | 독자, 호스트 플랫폼 (Obsidian) |
| 이해관계자와 관심 | 작성자: 노트를 쓰는 흐름을 끊지 않고 그림을 삽입하고 편집한다. 독자: 플러그인 없이 그림을 본다. 팀의 저장소(git): 같은 내용이면 같은 파일이다 |
| 사전 조건 | 볼트에 플러그인이 켜져 있다 |
| 최소 보장 | 노트의 다른 글과 볼트의 다른 파일은 바뀌지 않는다. 편집 중 오류가 나면 이미 있던 그림 파일이 그대로 남는지는 미결정(6장) |
| 성공 보장 | 볼트에 유효한 .ns.svg가 있고, 노트에 그 파일을 가리키는 ![[…]]가 있으며, 노트에 그 그림이 보인다 |
| 트리거 | 작성자가 노트 편집 화면의 컨텍스트 메뉴에서 “Insert new NS diagram”을 선택한다 |
기본 성공 시나리오
- 플러그인이 볼트에 새 다이어그램 파일을 만든다. 파일의 이름과 폴더는 미결정(6장)
- 플러그인이 노트의 커서 자리에 그 파일을 삽입하는
![[…]]를 넣는다. - 플러그인이 편집 탭을 연다.
- 작성자가 블록을 편집한다 → UC-03
- 작성자가 저장한다 → UC-06
- 플러그인이 노트의 그림을 새 그림으로 바꾼다.
- 독자가 노트를 열어 그림을 본다.
확장
- 1a. 같은 이름의 파일이 있다: 미결정(6장)
- 4a. 작성자가 아무것도 그리지 않고 탭을 닫는다: 미결정(6장)
- 6a. 노트가 이미 열려 있으면 다시 열지 않고 그림만 바뀐다. 같은 그림을 삽입한 다른 노트도 같다
- 7a. 독자에게 플러그인이 없어도 그림은 보인다(편집 메뉴만 없다)
기술 변형
- 트리거’. Obsidian의 명령 팔레트(Command palette)에서 실행한다
- 3’. 이미 삽입한 그림의 컨텍스트 메뉴에서 “Edit NS diagram”을 선택하면 3부터 시작한다
빈도: 노트에 알고리즘을 설명할 때마다
요구사항: R-OBS-01, R-OBS-03, R-OBS-02, R-OBS-04, R-OBS-07, R-OBS-10, R-FMT-07
UC-08 공유하고 내보낸다
- 액터: 작성자, 독자
- 사전 조건: 다이어그램이 편집기에 열려 있다
기본 흐름
- 작성자가 내보낼 형식을 선택한다: PNG(배율), 모델을 뺀 SVG, PDF.
- 편집기가 그 파일을 만든다.
- 작성자가 그 파일을 문서 · 슬라이드 · 이슈에 붙인다. 독자는 그 파일을 본다.
예외 흐름
- 1a. 공유 URL을 만든다(파일 › 공유 링크 복사). 다이어그램 전체가 URL에 담기고, 독자는 링크만으로 연다(보기 모드) → 3. 공유 URL과 보기 모드
- 1b. 인쇄한다. 큰 다이어그램은 여러 페이지로 나뉜다
- 3a. 저장 파일(
.ns.svg) 그대로 GitHub · Drive · 문서 도구에 두어도 그림으로 보인다 → UC-06 - 3b. 다른 뷰어에서도 글꼴이 똑같이 보이게 텍스트를 외곽선으로 바꿔 저장한다(
P1)
요구사항: R-EXP-01, R-EXP-02, R-EXP-03, R-WEB-05, R-WEB-06, R-GD-04, R-FMT-10
UC-09 그림의 모양을 정한다
- 액터: 작성자
- 사전 조건: 다이어그램이 편집기에 열려 있다
기본 흐름
- 작성자가 문서의 테마(그림의 색 묶음)를 선택한다.
- 작성자가 블록 텍스트의 언어(일반 텍스트 / C / Java / Python / Bash 등)를 선택하면, 블록 텍스트가 그 문법으로 강조된다.
- 작성자가 Event · Method 헤더의 모양을 선택한다.
- 선택한 것은 문서에 저장되어, 누가 어디서 열어도 같은 모양이다.
예외 흐름
- 1a. 편집 화면의 밝기(밝음 · 어두움)는 문서의 테마와 따로다. 저장되는 그림은 문서의 테마를 따른다
- 1b. 화면의 언어는 사용자의 설정이다. 그림에 적히는 텍스트(“참”, “거짓” 등)는 문서 설정의 “그림 문구의 언어”를 따른다. 새 문서는 만든 사람의 화면 언어로 시작한다
요구사항: R-LAY-08, R-LAY-06, R-LAY-07, R-LAY-10, R-LAY-05, R-OBS-10, R-FMT-08, R-NFR-04
UC-10 문제를 알린다
- 액터: 작성자
- 사전 조건: 없음
기본 흐름
- 작성자가 문제 알리기를 연다.
- 편집기가 보고서를 만든다.
- 작성자가 보고서를 보낸다.
예외 흐름
- 1a. 예상하지 못한 오류가 나면 편집기가 먼저 “이 문제를 알리시겠어요?”를 묻는다
요구사항: R-REP-01, R-REP-02, R-REP-04
5. 이후에 추가되는 유즈케이스
배포 대상이 더해질 때 씁니다. 지금은 이름과 요구사항만 둡니다.
| 유즈케이스 | 요구사항 |
|---|---|
| 코드와 다이어그램을 오간다 (IDE) | R-IDE-03, R-IDE-04, R-IDE-05, R-IDE-06, R-CODE-01, R-CODE-02, R-CODE-03, R-SKILL-02 |
| 말로 다이어그램을 그린다 (AI) | R-WEB-07, R-SKILL-01, R-SKILL-03 |
| Confluence 페이지에 넣어 보인다 | R-CF-01 (UC-07과 같은 흐름) |
| 다른 도구의 파일을 가져온다 | R-EXP-05 |
| 실행을 따라가며 본다 (교육용) | R-CODE-04 |
6. 미결정 사항
유즈케이스를 쓰다가 드러난, 요구사항에 답이 없는 질문입니다. 대부분 자세한 형식의 최소 보장과 확장을 채우다가 찾았습니다.
미결정: 열기 (UC-02)
- 1d. 같은 파일이 이미 다른 창이나 탭에 열려 있으면 그 창으로 가나, 하나 더 여나? 웹은 정했다(나중에 연 탭은 보기만 → 2. 로컬 백업과 자동 저장). Obsidian · 데스크톱은 정하지 않았다
- 3b. 옛 형식 버전의 파일을 열면, 원본은 저장하기 전까지 옛 형식 그대로인가? 저장하면 옛 버전의 앱으로는 못 여는데, 그것을 알리나?
미결정: 저장 (UC-06)
- 최소 보장: 쓰다가 실패하면 원본 파일은 온전히 남는가(임시 파일에 쓰고 바꿔치기)? 호스트마다 할 수 있는 것이 다르다
- 3b. 쓰기에 실패하면 다시 시도하게 하나, 다른 이름으로 저장하게 하나?
- 3c. 연 뒤에 파일이 다른 곳에서 바뀌었으면 덮어쓰나, 알리나, 선택하게 하나?
미결정: 노트에 삽입해 보이기 (UC-07)
- 새 파일의 이름과 둘 폴더, 4a. 아무것도 그리지 않고 탭을 닫았을 때 → 미결정 사항
- 1a. 같은 이름의 파일이 있으면 번호를 붙이나, 묻나?
- 최소 보장: 편집 중 오류가 나면 이미 있던 그림 파일은 그대로 남는가?