요구사항
NS 차트(Nassi-Shneiderman Diagram)를 그리는 프로그램의 요구사항입니다. 이 문서는 무엇을 만드는지만 다룹니다. 요구사항 하나는 한두 줄입니다. 그 기능이 사용자에게 어떻게 보이고 어떤 규칙으로 움직이는지는 UX 설계(01-ux-overview, 02-interaction-rules)에(결정은 → UX 결정 모음), 왜 그렇게 정했는지는 ADR에, 어떻게 만드는지는 01-architecture와 상세 설계 문서에 있습니다.
읽는 법
- 우선순위:
P0= 필수 ·P1= 1차 확장 ·P2= 나중에 ·P3= 웹 베타 뒤. 요구사항 표의 “우선순위” 칸에 적습니다. 우선순위는 기능의 우선순위입니다.P0은 “그 배포 대상을 낼 때 꼭 있어야 하는 것”이고, 배포 대상을 내는 순서(웹 → Obsidian → 데스크톱)는 DR-0002가 정합니다. MVP는 웹의P0입니다(5. MVP 범위, DR-0015).- 우선순위는 Obsidian 태그(
#P0)로 달지 않습니다. 태그는 문서에 붙는 것이기 때문입니다(2026-11-01부터, 그 전에는 태그였습니다).P0만 모아 본 목록은 5. MVP 범위입니다.- 요구사항 끝의 ”→ 상세”는 그 기능의 세부 규칙이 적힌 설계 문서로 갑니다.
- 기능들이 이어지는 사용자의 흐름은 유즈케이스에 있습니다.
- 요구사항마다 ID(
R-WEB-02:R-, 영역, 번호)가 있습니다. 다른 문서는[[01-requirements#r-web-02|R-WEB-02]]처럼 그 요구사항이 든 표(^r-web)를 가리키고, 링크에 보이는 글자는 ID입니다. Obsidian에서는 링크가 그 표로 가고(링크에 마우스를 올리면(호버) 표가 미리 보입니다), 배포한 사이트에서는 그 줄로 바로 갑니다. Obsidian은 표의 한 줄을 가리키지 못합니다 → DR-0016- ID는 바뀌지 않습니다. 새 요구사항은 그 영역의 다음 번호를 받습니다. 철회한 요구사항은 이 문서에서 지우고 요구사항 변경 기록에 남기며, 그 번호는 다시 쓰지 않습니다.
- 영역:
CORE핵심 원칙 ·TGT배포 대상 ·ALL모든 배포 대상 ·OBSObsidian ·DSK데스크톱 ·WEB웹 ·GDGoogle Drive ·CFConfluence ·SKILLClaude skill ·IDEIDE 플러그인 ·BLK블록 ·EDIT편집 ·LAY레이아웃 ·FMT파일 형식 ·EXP내보내기 · 가져오기 ·CODE코드 연동 ·REP문제 알리기 ·NFR비기능
1. 핵심 원칙
| ID | 원칙 |
|---|---|
| R-CORE-01 | NS 차트는 트리 구조다. 이 프로그램은 도형을 자유롭게 배치하는 그림판이 아니라, 구조를 편집하면 그림이 자동으로 그려지는 편집기다. 사용자는 좌표를 직접 다루지 않는다. → ADR-0004 |
| R-CORE-02 | 구조적으로 잘못된 차트(예: 반복문 밖으로 튀어나온 블록)는 만들 수 없어야 한다. |
| R-CORE-03 | 주 사용자는 실무에서 설계 문서를 쓰는 사람이다. 코드와 함께 두는 문서, PDF와 인쇄의 품질을 앞에 둔다. 교육용 기능(실행 애니메이션 등)은 그 뒤다. |
| R-CORE-04 | 저장 파일 하나가 그림이자 원본이다. 파일은 어디서나 열리는 SVG 이미지이고, 그 안에 다이어그램 모델이 함께 들어 있어 다시 열어 편집할 수 있다. → ADR-0005 |
2. 배포 대상
먼저 만드는 것은 웹 · Obsidian 플러그인 · 데스크톱 셋이다. 그 위에 통합하거나 이후에 추가하는 대상이 넷 더 있다. → ADR-0002, ADR-0006, 만드는 순서는 DR-0002
| ID | 배포 대상 | 언제 | 값 | 저장하는 것 | 절 |
|---|---|---|---|---|---|
| R-TGT-01 | 웹 (정적 페이지) | 처음 (MVP) | 무료 | .ns | 2.3 |
| R-TGT-02 | Obsidian 플러그인 | 처음 | 무료 | .ns.svg | 2.1 |
| R-TGT-03 | 데스크톱 애플리케이션 | 처음 | 무료 | .ns | 2.2 |
| R-TGT-04 | Google Drive | 처음 셋 다음, 웹에 통합 (P1) | 무료 | .ns.svg | 2.4 |
| R-TGT-05 | Confluence | 나중에 (P2) | 유료 | 페이지 안의 다이어그램 | 2.5 |
| R-TGT-06 | IDE 플러그인 (VSCode, IntelliJ) | 나중에 (P2) | 무료 | 소스 코드 (코드가 원본) | 2.7 |
| R-TGT-07 | Claude skill | 나중에 (P2) | 무료 | .ns.svg와 공유 URL | 2.6 |
모든 배포 대상에 공통:
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-ALL-01 | 무료 배포 대상의 후원 링크(Buy Me a Coffee): 편집을 방해하지 않는 자리에 둔다 · 웹: 광고(R-WEB-08)와 같은 때(저장·내보내기·공유) 함께 보인다 · Obsidian: 플러그인 manifest의 fundingUrl에 적는다 (커뮤니티 플러그인 화면에 후원 버튼이 보인다)· 데스크톱: 도움말·정보 창에 둔다 | P3 |
| R-ALL-02 | .ns와 .ns.svg의 파일 내용은 같은 형식(다이어그램 모델이 포함된 SVG)이다. 뒤에 .svg를 붙이거나 떼는 것만으로 서로 열 수 있다 → 상세 | P0 |
| R-ALL-03 | 새 문서를 만든다: 다이어그램 하나와 빈 블록 하나가 든 문서(모든 배포 대상) → 상세 | P0 |
2.1 Obsidian 플러그인
사용 흐름은 drawio-obsidian 플러그인과 같다. 노트에서 바로 다이어그램을 삽입하고, 삽입한 그림에서 바로 편집한다.
flowchart LR A["노트 편집 중<br/>우클릭"] -->|Insert new NS diagram| B["NS 편집 탭 열림<br/>(새 .ns.svg 파일)"] B -->|편집 후 탭 닫기| C["노트의 커서 위치에<br/>![[이름.ns.svg]] 삽입"] C -->|삽입된 그림 우클릭<br/>Edit NS diagram| D["NS 편집 탭 열림"] D -->|편집 후 탭 닫기| E["노트의 그림이<br/>새 내용으로 갱신"]
노트에서 삽입 · 편집하기
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-OBS-01 | 노트 편집 화면의 컨텍스트 메뉴에 “Insert new NS diagram” 항목 · 누르면 새 .ns.svg 파일을 만들고 NS 편집 탭을 연다.· 편집을 마치고 탭을 닫으면, 우클릭했던 노트의 커서 위치에 ![[이름.ns.svg]]를 삽입한다. | P0 |
| R-OBS-02 | 노트에 삽입된 NS 다이어그램 그림의 컨텍스트 메뉴에 “Edit NS diagram” 항목 · 누르면 해당 파일을 NS 편집 탭으로 연다. · 저장하면 노트에 보이는 그림도 새 내용으로 갱신된다. | P0 |
| R-OBS-03 | 같은 기능을 Obsidian의 명령 팔레트(Command palette)에서도 실행 (“Insert new NS diagram”) | P0 |
| R-OBS-04 | 편집을 마치면, 그 그림을 삽입한 노트가 이미 열려 있어도 다시 열지 않고 새 그림으로 보인다. 같은 그림을 삽입한 다른 열린 노트도 마찬가지다. | P0 |
파일 다루기
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-OBS-05 | 파일 이름이 .ns.svg로 끝나는 파일을 파일 탐색기에서 열면 NS 편집 탭으로 열기 | P0 |
| R-OBS-06 | 그 밖의 일반 .svg 파일은 건드리지 않고 Obsidian 기본 동작으로 열기 | P0 |
| R-OBS-07 | 노트에 삽입된 ![[이름.ns.svg]]는 플러그인이 없어도 그림으로 보임 | P0 |
| R-OBS-08 | 파일 탐색기 컨텍스트 메뉴에서 새 NS 다이어그램 만들기 (노트에 삽입하지 않음) | P1 |
| R-OBS-09 | 이름 변경으로 .ns가 빠졌지만 모델이 들어 있는 .svg 파일은 내용으로 감지해서 “Edit NS diagram” 메뉴 제공 | P1 |
화면
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-OBS-10 | Obsidian 라이트/다크 테마에 맞춰 편집 화면 표시 (저장되는 그림의 색은 편집 화면의 밝기를 따르지 않는다 → R-FMT-08) | P1 |
미결정
새 파일의 이름과 저장 위치, 아무것도 그리지 않고 탭을 닫았을 때, 편집 중 저장 시점은 설계에서 정한다 → 미결정 사항
2.2 데스크톱 애플리케이션
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-DSK-01 | .ns 파일 열기/저장/다른 이름으로 저장 | P0 |
| R-DSK-02 | .ns.svg 파일도 열기 (Obsidian 볼트의 파일을 직접 편집) | P1 |
| R-DSK-03 | OS 파일 연결: .ns 더블클릭 시 앱으로 열기 | P1 |
| R-DSK-04 | 여러 창 또는 탭으로 동시에 여러 파일 편집 | P1 |
| R-DSK-05 | 자동 업데이트 | P2 |
2.3 웹 (정적 페이지)
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-WEB-01 | 서버 없이 정적 호스팅만으로 동작 (GitHub Pages 등) → 상세 | P0 |
| R-WEB-02 | 로컬 .ns 파일 열기/저장 (.ns.svg도 열기 가능)· 지원 브라우저(Chromium 계열)에서는 원래 파일에 덮어쓰기 · 미지원 브라우저에서는 파일 업로드와 다운로드로 대체 → 상세 | P0 |
| R-WEB-03 | 작성 중인 내용 브라우저 저장소에 로컬 백업 (새로고침해도 복구) → 상세 | P0 |
| R-WEB-04 | PWA (오프라인 사용, 설치) | P2 |
| R-WEB-05 | 공유 URL: 다이어그램 전체를 압축해 URL에 담고, 링크만으로 연다. 서버가 필요 없다 · 아주 큰 다이어그램은 URL 길이 제한에 걸린다. 그때는 파일로 공유하라고 안내한다. → 상세 | P1 |
| R-WEB-06 | 보기 모드: 편집 화면 없이 그림만 보여 준다. 공유 URL을 열면 이 모드로 시작하고, 버튼 하나로 편집 모드로 바꾼다 → 상세 | P1 |
| R-WEB-07 | AI 대화창: 말로 다이어그램을 만들거나 편집한다. 예: “퀵소트를 그려 주세요”, “반복되는 부분을 Method로 빼 주세요”. 서버가 없으므로 사용자가 자기 API 키(Claude, ChatGPT, Grok)를 넣고, 키는 그 브라우저에만 보관한다 | P3 |
| R-WEB-08 | 광고: 편집 화면을 가리거나 좁히지 않는다. 저장·내보내기·공유 URL을 만들 때만 보인다 · 정확한 자리는 정하지 않았다 → 6. 미결정 사항 | P3 |
| R-WEB-09 | 브라우저 안의 문서: 파일 없이 문서에 이름을 붙여 그 브라우저에 저장하고, 목록에서 열고 지운다 · 브라우저 데이터를 지우면 함께 지워진다는 것을 화면에 알리고, 파일로 내보낼 방법을 제공한다 → 상세 | P1 |
| R-WEB-10 | LLM · 에이전트를 위한 안내서(/llms.txt): 다른 AI가 공유 URL(R-WEB-05)을 만들어 주고, 사용자가 준 공유 URL을 읽을 수 있게 한다 → 상세 | P1 |
| R-WEB-11 | AI가 준 텍스트로 열기: 모델 JSON이나 공유 링크를 붙여넣어 새 문서로 연다 → 상세, 웹 | P1 |
| R-WEB-12 | 알고리즘 갤러리: 잘 알려진 알고리즘을 NS 차트로 보여 주는 페이지. 그림마다 편집기에서 열거나 .ns.svg로 받는다 → 상세 | P2 |
- 참고 모델: SequenceDiagram.org (공유 URL, 저장 장소 선택, 보기 모드, 도움말)
2.4 Google Drive
웹 버전에 Drive 연동을 추가한 형태다. → ADR-0012, ADR-0014
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-GD-01 | Drive에서 NS 파일을 우클릭해 “AriadneNSD로 열기”로 편집 | P1 |
| R-GD-02 | Drive의 “새로 만들기” 메뉴에서 새 NS 다이어그램 만들기 | P1 |
| R-GD-03 | 편집한 내용을 Drive의 원래 파일에 저장 | P1 |
| R-GD-04 | Drive 미리보기와 썸네일에서 다이어그램 그림이 보임 | P1 |
| R-GD-05 | Drive에서 만드는 파일은 .ns.svg로 저장한다 | P1 |
2.5 Confluence (유료, 나중에)
Confluence 안에서 바로 쓸 수 있다는 편의로 가치를 낸다.
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-CF-01 | Confluence 페이지에 NS 다이어그램을 삽입하고, 페이지 안에서 편집 · Atlassian Marketplace에는 새 앱을 Forge로만 올릴 수 있다. Forge 앱은 Confluence 안의 iframe에 웹 화면을 띄우므로 웹 버전과 구조가 거의 같다. · 아키텍처는 이후에 추가되는 배포 대상(셸)의 자리를 남겨 둔다 → ADR-0036 | P2 |
| R-CF-02 | 유료로 판다(다른 배포 대상은 모두 무료다). 기능은 무료 버전과 같다 | P2 |
2.6 Claude skill (나중에)
Claude와 대화하며 NS 다이어그램을 만들고 읽는다. 알고리즘을 물으면 그려 주고(예: “퀵소트를 설명해 줘”), 소스 코드를 다이어그램으로 옮기고, 사용자가 준 다이어그램을 읽어 설명하거나 고친다. 만드는 것은 언제나 AriadneNSD에서 그대로 열리는 파일과 공유 URL이다.
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-SKILL-01 | Claude skill: 설명할 알고리즘을 NS 모델로 만들어 .ns.svg 파일과 공유 URL(R-WEB-05)을 함께 생성한다. 파일은 AriadneNSD에서 그대로 열어 편집할 수 있다 | P2 |
| R-SKILL-02 | 코드 → 다이어그램: 소스 코드의 함수를 NS 모델로 옮겨 .ns.svg 파일과 공유 URL을 생성한다. 함수는 Method, 함수 호출은 호출 블록이 된다. 파서 없이 Claude가 코드를 읽는다(파서로 하는 변환은 R-CODE-03) | P2 |
| R-SKILL-03 | 다이어그램 읽기 · 고치기: 공유 URL이나 .ns.svg 파일의 다이어그램을 읽어 설명 · 검토하고, 말로 한 요청대로 고친 .ns.svg 파일과 새 공유 URL을 돌려준다. 예: “반복되는 부분을 Method로 빼 주세요” | P2 |
2.7 IDE 플러그인 (나중에)
코드를 짜는 자리에서 그 코드를 NS 다이어그램으로 보고 편집한다.
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-IDE-01 | VSCode 플러그인 | P2 |
| R-IDE-02 | IntelliJ 플러그인 (VSCode 다음) | P2 |
| R-IDE-03 | 리버스 엔지니어링: 열어 둔 소스 코드를 다이어그램으로 보여 준다 → R-CODE-03 | P2 |
| R-IDE-04 | 코드 생성: 다이어그램을 코드로 만든다 → R-CODE-02 | P2 |
| R-IDE-05 | 접기 영역은 코드의 영역 주석(region … endregion)으로 남긴다. 접힘 상태는 코드에 적지 않고 IDE가 그 컴퓨터에 기억한다 | P2 |
| R-IDE-06 | 양방향 실시간 반영: 코드를 수정하면 다이어그램이, 다이어그램을 편집하면 코드가 바로 따라 바뀐다 | P3 |
| R-IDE-07 | 코드가 원본이다. 다이어그램은 코드에서 만들어 보여 주는 것이고, 다이어그램을 편집하면 코드가 바뀐다. .ns 파일은 만들지 않는다. 그림이 필요하면 내보내기로 생성한다 | P2 |
| R-IDE-08 | 논리 · 물리 뷰: 블록 하나를 설명 문장(논리, 예: “반으로 나눈다”)과 코드(물리, 예: mid = (lo + hi) >> 1)의 두 얼굴로 보고, 보는 얼굴을 바꿀 수 있다 | P2 |
3. 기능 요구사항
3.1 블록 종류
DIN 66261(1985년 독일 표준, 유료) / 원 논문(Nassi · Shneiderman, “Flowchart Techniques for Structured Programming”, SIGPLAN Notices 8(8), 1973, ACM) 기준입니다.
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-BLK-01 | 처리(Process) 블록: 한 단계의 명령 | P0 |
| R-BLK-02 | 선택(If-Then-Else) 블록: 조건에 따라 참 분기나 거짓 분기를 실행 | P0 |
| R-BLK-03 | 전위 판정 반복(While) 블록: 조건을 먼저 검사하고 본문을 반복 | P0 |
| R-BLK-04 | 후위 판정 반복(Do-While / Repeat-Until) 블록: 본문을 먼저 실행하고 조건을 검사 | P0 |
| R-BLK-05 | 다중 선택(Case) 블록: 조건 하나에 분기 여러 개와 default 분기 → 상세 | P0 |
| R-BLK-06 | 횟수 반복(For) 블록: While의 변형 | P0 |
| R-BLK-07 | 호출 블록: 같은 문서의 Method를 호출한다. NS 차트 표준의 서브루틴 호출 표기로 그린다 → 상세 | P0 |
| R-BLK-08 | 이름을 적는 호출 블록: 호출할 것이 문서에 없으면(라이브러리 함수, 아직 그리지 않은 서브루틴) 이름 · 인자 · 결과를 직접 적어 호출한다. 보통 호출 블록과 같은 모양이다 → 상세 | P1 |
| R-BLK-10 | Event 헤더(이벤트 헤더): 다이어그램 맨 위에 “버튼을 누르면”, “타이머가 끝나면” 같은 이벤트를 다는 헤더. NS 차트 표준에는 없고 Scratch에서 가져온 표기다 → 상세 | P0 |
| R-BLK-11 | Method 헤더: 호출 블록이 호출하는 다이어그램(Method, Sub process)의 헤더. Event 헤더와 다른 모양으로 그려 구분한다 (→ ADR-0021) → 상세 | P0 |
| R-BLK-12 | 탈출(Exit / Break / Return) 블록: 반복 · 함수 탈출 | P2 |
| R-BLK-13 | 병렬 처리(Parallel) 블록: 동시 실행 분기 | P2 |
| R-BLK-14 | 주석 블록 | P2 |
블록과 헤더를 어떤 모양으로 그리는지는 설계에 있다 → 블록의 모양
3.2 편집
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-EDIT-01 | 블록 선택, 삽입(선택한 블록의 앞/뒤(빈 블록이면 그 자리)), 삭제, 텍스트 편집 → 상세 02-interaction-rules, 키는 03-keymap | P0 |
| R-EDIT-02 | 실행 취소 / 다시 실행 (Undo/Redo) → 상세 02-interaction-rules | P0 |
| R-EDIT-03 | 키보드만으로 편집 가능: 방향키로 이동, 단축키로 블록 삽입, 단축키로 블록 · 분기 · 다이어그램 이동(이동) → 상세 | P0 |
| R-EDIT-04 | 두 키를 이어 누르는 명령은 첫 키를 누르면 이어 누를 키와 그 명령을 안내한다 → 상세 | P0 |
| R-EDIT-05 | 여러 블록 선택. 선택할 수 있는 범위는 R-EDIT-22 → 상세 | P0 |
| R-EDIT-06 | 선택한 블록들을 새 제어 블록 안에 넣어 감싸기 (IDE의 “Surround With”와 같은 기능) → 상세 | P0 |
| R-EDIT-07 | 제어 블록 풀기: 제어 블록만 삭제하고 안의 블록은 그 자리에 남기기 → 상세 | P0 |
| R-EDIT-08 | 호출 블록 풀기: 호출 블록을 그 블록이 호출하는 Method의 블록들로 바꾼다 (Method로 빼기의 반대) → 상세 | P1 |
| R-EDIT-09 | 드래그 앤 드롭으로 블록 하나 또는 선택한 블록들을 통째로 이동 (놓을 수 있는 자리 미리 강조). 툴바의 블록 아이콘을 드래그해 새 블록을 삽입하거나, 블록 위에 놓아 감싼다 → 상세 | P0 |
| R-EDIT-10 | 복사 / 잘라내기 / 붙여넣기 (하위 트리 통째로) → 상세 | P0 |
| R-EDIT-11 | If 블록의 참/거짓 분기 바꾸기, Case 분기 추가·삭제·순서 바꾸기 → 상세 분기 삽입 · 삭제, 순서 바꾸기 | P0 |
| R-EDIT-12 | If 블록의 분기 라벨(“참” · “거짓”)을 편집한다 → 상세 | P0 |
| R-EDIT-13 | 제어 블록 접기/펼치기: 제어 블록의 안쪽을 접는다. If·Case는 분기별로 → 상세 | P1 |
| R-EDIT-14 | 접기 영역: 선택 영역을 접기 영역으로 만들어 접고 펼친다. 이름은 R-EDIT-23, 파일에 저장하는 것은 R-FMT-11 → 상세 | P1 |
| R-EDIT-15 | 호출 블록 펴 보기: 호출 블록을 펴면 호출하는 Method의 블록들이 그 자리에 보인다. 보기만 바뀌고 다이어그램의 내용은 바뀌지 않는다 → 상세 | P1 |
| R-EDIT-16 | 펴 보인 곳의 접기 영역: 펴 보인 호출 블록 안에서 접기 영역을 만든다. 그 호출 블록 자리에만 있고 Method의 원본은 바뀌지 않는다 → 상세 | P1 |
| R-EDIT-17 | 모두 접기 / 모두 펼치기 / 깊이 n까지 펼치기 | P2 |
| R-EDIT-18 | 한 문서에 여러 다이어그램: Event(이벤트 처리기)와 Method 여러 개를 한 화면에 나란히 둔다 → 상세 | P0 |
| R-EDIT-19 | 선택한 블록들을 새 Method로 빼기: 선택한 블록들이 새 Method 다이어그램이 되고, 그 자리에는 그 Method를 호출하는 호출 블록(R-BLK-07)이 남는다 → 상세 | P1 |
| R-EDIT-20 | 자주 쓰는 블록 묶음: 자주 쓰는 블록을 저장해 두고 드래그해 쓴다 (Scratch의 하드웨어 전용 블록 묶음처럼) | P2 |
| R-EDIT-21 | 도움말: 사용법을 한 페이지로 안내하고, 단축키 목록을 볼 수 있게 한다(본보기: SequenceDiagram.org의 Instructions) (모든 배포 대상) → 상세 | P0 |
| R-EDIT-22 | 여러 블록 선택은 언제나 같은 부모 아래에서 연속으로 붙어 있는 블록 범위다 → ADR-0008 → 상세 | P0 |
| R-EDIT-23 | 접기 영역에 이름을 붙인다 → ADR-0017, 상세 | P1 |
| R-EDIT-24 | 커맨드 팔레트: 명령 이름의 일부를 쳐서 명령을 찾아 실행한다(VS Code의 Command Palette, IntelliJ의 Find Action). 찾은 명령마다 같은 일을 하는 키를 함께 보인다 → 상세 커맨드 팔레트 | P0 |
| R-EDIT-25 | 예제: 만들어 둔 예제 다이어그램을 골라 연다. 처음 온 사람에게는 예제를 볼지 묻는다 → 상세 | P0 |
| R-EDIT-26 | Method 만들기: 이름을 적는 호출 블록(R-BLK-08)에서 그 이름의 Method 다이어그램을 만들어 잇는다 → 상세 | P1 |
| R-EDIT-27 | Method 풀어 넣고 지우기: Method를 호출하는 모든 호출 블록을 그 Method의 블록들로 바꾸고 Method를 지운다 → 상세 | P1 |
3.3 레이아웃 · 렌더링
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-LAY-01 | 텍스트 길이에 따라 블록 너비·높이 자동 조정, 여러 줄 텍스트 지원 | P0 |
| R-LAY-02 | 분기 너비 자동 분배 (어느 분기가 깊어져도 전체 직사각형 유지) | P0 |
| R-LAY-03 | 확대/축소, 화면 이동 → 상세 | P0 |
| R-LAY-04 | 한글/영문 혼용 텍스트의 정확한 폭 측정 | P0 |
| R-LAY-05 | 기본 스타일: 옅은 단색 배경, 가는 선, 반복·분기의 조건 칸과 호출 블록에 옅은 색조 → DR-0003, 상세 04-visual-design | P0 |
| R-LAY-06 | 블록 텍스트의 언어를 문서마다 하나 선택한다: 일반 텍스트 / C / C++ / Java / JavaScript · TypeScript / Python / Bash → 상세 | P1 |
| R-LAY-07 | 블록 텍스트의 구문 강조 (키워드, 주석을 다른 색으로). 선택한 언어(R-LAY-06)의 문법을 따르고, 일반 텍스트면 강조하지 않는다 → 상세 | P1 |
| R-LAY-08 | 테마: 그림의 색 묶음을 문서마다 선택한다(파일에 저장). 테마에는 밝은 테마와 어두운 테마가 있고, 처음에는 종류마다 기본 테마 하나씩 둔다. 편집 화면의 색은 테마가 아니다. 흑백 인쇄 모드를 포함한다. 테마를 바꿔도 레이아웃은 그대로다(그래서 글꼴과 선 굵기는 테마가 아니다) → 상세 | P1 |
| R-LAY-09 | If · Case의 빈 분기는 비어 있음을 기호로 보인다 → 상세 모양 표 | P0 |
| R-LAY-10 | Event · Method 헤더의 모양을 문서마다 선택한다: 헤더 블록의 모양 그대로, 또는 모양 없이 다이어그램의 제목처럼 → 상세 모양 표 | P0 |
| R-LAY-11 | 블록별 배경색 지정 | P2 |
3.4 파일 형식
세부 명세는 01-file-format에 있다. → ADR-0005, ADR-0007
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-FMT-01 | 저장 파일은 유효한 SVG 1.1 문서이며, 브라우저·이미지 뷰어·Obsidian·문서 도구에서 그대로 그림으로 보인다. | P0 |
| R-FMT-02 | 다이어그램 모델은 SVG 안에 JSON으로 들어 있고, 형식 버전을 포함한다. 이전 버전 파일은 불러올 때 자동 변환한다. | P0 |
| R-FMT-03 | 같은 모델이면 항상 같은 파일 내용이 나온다. | P0 |
| R-FMT-04 | 블록 텍스트에 어떤 문자가 들어가도(]]> 포함) 파일이 깨지지 않는다. | P0 |
| R-FMT-05 | 열 때는 모델만 읽고, 저장할 때마다 그림 부분을 모델에서 새로 생성한다. | P0 |
| R-FMT-06 | 모델이 없거나 손상된 SVG를 열면 편집 불가 안내를 표시한다 (그림을 역해석하지 않음). | P0 |
| R-FMT-07 | 그림 속 텍스트는 텍스트로 남긴다. 편집기에 번들한 글꼴에서 쓰인 문자만 추려 파일에 함께 포함해, 그 글꼴이 없는 곳에서도 텍스트가 칸에 맞게 한다. 대체 글꼴 목록도 지정한다. → ADR-0026 | P0 |
| R-FMT-08 | 저장되는 그림의 색은 문서의 색(문서가 선택한 테마의 색)이다. 편집 화면이 어두워도, 보는 곳이 어두워도 같은 색으로 저장되고 보인다. | P0 |
| R-FMT-09 | 다른 도구로 그림 부분만 수정한 파일을 열면, 그림이 모델과 달라졌음을 알린다. 저장하면 그 변경이 사라진다는 것도 함께 알린다. → 상세 | P1 |
| R-FMT-10 | 다른 뷰어에서도 글꼴이 똑같이 보이도록 텍스트를 외곽선(path)으로 바꿔 저장하는 옵션 (모델에는 텍스트가 그대로 남음) → 상세 | P1 |
| R-FMT-11 | 접힘 상태와 접기 영역의 이름은 파일에 함께 저장한다. 저장되는 그림은 지금 화면 그대로다 → ADR-0017, ADR-0018, 상세 | P1 |
| R-FMT-12 | 마크다운 문서에서 언어 이름이 nschart인 코드 블록에 글로 적은 NS 차트를 그림으로 보인다. 이 글은 사람과 Claude가 손으로 쓰는 형식이라, .ns.svg 안의 모델 JSON(R-FMT-02)과 따로 정한다 → 6. 미결정 사항 | P3 |
모델이 원본
다른 도구(Inkscape 등)로 그림 부분만 수정한 내용은 다시 열면 사라집니다. 대신 편집기가 이를 알려 줍니다(R-FMT-09).
3.5 내보내기 · 가져오기
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-EXP-01 | PNG 내보내기 (배율 선택) | P0 |
| R-EXP-02 | 모델을 제거한 순수 SVG 내보내기 (외부 공유용) → 상세 | P1 |
| R-EXP-03 | PDF 내보내기, 인쇄 (큰 다이어그램은 여러 페이지로 분할) → 상세 PDF, 인쇄, 페이지 나누기 | P1 |
| R-EXP-04 | 자동 저장(원래 파일에 쓸 수 없는 브라우저는 로컬 백업만), 최근 파일 목록 (데스크톱·웹) → 상세 자동 저장, 최근 파일 | P0 |
| R-EXP-05 | Structorizer .nsd 파일 가져오기 | P2 |
3.6 코드 연동
후순위
코드 연동은 편집기 기본 기능이 안정된 뒤에 진행합니다. 모든 항목이
P2입니다.
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-CODE-01 | 의사코드 텍스트 → 차트 변환 (들여쓰기 기반의 간단한 DSL, 텍스트와 차트 양방향 동기화) | P2 |
| R-CODE-02 | 차트 → 코드 생성 (C, Python, Java 등) | P2 |
| R-CODE-03 | 소스 코드 → 차트 (파서 필요) | P2 |
| R-CODE-04 | 단계별 실행 애니메이션 (교육용) | P2 |
3.7 문제 알리기
| ID | 요구사항 | 우선순위 |
|---|---|---|
| R-REP-01 | 문제 알리기: 보고서를 만들어 보낸다. 착각이나 어설픈 보고가 이슈 목록에 누적되지 않게 한다 → 상세 | P3 |
| R-REP-02 | 예상 못 한 오류가 나면 “이 문제를 알리시겠어요?”를 묻는다 | P3 |
| R-REP-03 | 보고서를 자동으로 보내지 않는다(서버가 없다). 사용자가 보낼 내용을 보고 직접 보낸다 | P3 |
| R-REP-04 | 사용자가 문제를 쉽게, 그리고 메인테이너가 재현할 수 있을 만큼 정확하게 알린다 | P3 |
4. 비기능 요구사항
측정할 수 있는 시나리오와 합격 기준, 확인할 테스트는 품질 속성 시나리오(QAS)에 있습니다.
| ID | 품질 | 요구사항 | 우선순위 |
|---|---|---|---|
| R-NFR-01 | 정합성 | 어떤 편집 연산을 거쳐도 트리는 항상 유효해야 한다 (빈 분기는 빈 처리 블록으로 자동 채움). | P0 |
| R-NFR-02 | 호환성 | 배포 대상들이 만든 파일(.ns, .ns.svg)은 서로 열 수 있어야 한다. 같은 모델이면 같은 SVG를 생성해야 한다 (불필요한 git diff 방지). | P0 |
| R-NFR-03 | 성능 | 블록 500개 규모에서 편집 반응 100ms 이내. | P0 |
| R-NFR-04 | 다국어 | 화면의 텍스트(UI)는 여러 언어를 지원한다. 기본은 영어이고 한국어를 지원한다. 언어는 설정에서 선택한다. 편집기가 그림에 적는 텍스트(If의 “참” · “거짓”, 접힌 줄의 “블록 n개”, 새 헤더의 기본 이름)는 문서마다 정한 언어를 따르고, 새 문서는 만든 사람의 화면 언어로 시작한다 → ADR-0041. 텍스트는 UTF-8. | P0 |
| R-NFR-05 | 접근성 | 키보드 전용 조작. 고대비 화면은 R-NFR-07로 나눔(2026-11-01) | P0 |
| R-NFR-06 | 테스트 가능성 | 모델·레이아웃·렌더러를 분리해서 레이아웃 계산을 단위 테스트할 수 있어야 한다. | P0 |
| R-NFR-07 | 접근성 | 고대비 화면 → 상세, 검증 | P1 |
| R-NFR-08 | 호환성 | 웹은 휴대폰(Android의 Chrome)에서 열리고, 터치로 보고 편집할 수 있다 → 화면 배치의 좁은 화면 | P0 |
| R-NFR-09 | 성능 | 웹은 휴대폰과 느린 모바일 망에서도 몇 초 안에 편집 화면이 보인다 → QA-18 | P0 |
| R-NFR-10 | 신뢰성 | 웹은 시작하지 못하면 빈 화면 대신 그 이유를 보인다 → 상세 | P0 |
5. MVP 범위
웹의 P0 항목입니다. 제품의 뼈대(모델 → 레이아웃 → 저장되는 SVG → 편집기 → 웹)를 처음부터 끝까지 세우고, 공개해 반응을 봅니다. 함수 하나를 옮겨 그릴 수 있는 만큼을 넣습니다 → DR-0015
- 블록 6종: 처리, If, Case, While, Do-While, For (R-BLK-01 ~ R-BLK-06)
- 새 문서 만들기 (R-ALL-03)
- 키보드/마우스 편집 + Undo/Redo, 키 힌트 (R-EDIT-01, R-EDIT-02, R-EDIT-03, R-EDIT-04)
- 여러 블록 선택 (연속 범위, 자동 확장) (R-EDIT-05, R-EDIT-22)
- 감싸기 · 풀기, 복사 · 잘라내기 · 붙여넣기, 분기 변경 · 추가 · 삭제 (R-EDIT-06, R-EDIT-07, R-EDIT-10, R-EDIT-11)
- 드래그 앤 드롭으로 블록 이동 · 툴바의 블록 아이콘으로 삽입 · 감싸기 (R-EDIT-09)
- If 분기 라벨 편집 (R-EDIT-12), 빈 분기 기호 (R-LAY-09)
- 자동 레이아웃 (R-LAY-01, R-LAY-02)
- 확대 · 축소와 화면 이동(줌 · 팬) (R-LAY-03)
- 한글 · 영문 섞인 텍스트의 정확한 폭 측정 (R-LAY-04)
- 기본 스타일 (R-LAY-05)
- 모델 내장 SVG 저장/불러오기 (R-FMT-01 ~ R-FMT-08, R-WEB-02)
.ns와.ns.svg는 같은 형식 (R-ALL-02)- 서버 없이 정적 호스팅만으로 동작 (R-WEB-01)
- 작성 중인 내용의 로컬 백업, 자동 저장 · 최근 파일 (R-WEB-03, R-EXP-04)
- PNG 내보내기 (R-EXP-01)
- 도움말 (R-EDIT-21)
- 예제 (R-EDIT-25)
- Event · Method 헤더와 그 모양 고르기, 같은 문서의 Method를 참조하는 호출 블록, 한 문서에 여러 다이어그램 (R-BLK-10, R-BLK-11, R-LAY-10, R-BLK-07, R-EDIT-18). 예제가 쓰기 때문이다
- 커맨드 팔레트 (R-EDIT-24)
- 비기능 요구사항 가운데
P0인 것 (R-NFR-01 ~ R-NFR-06, R-NFR-08 ~ R-NFR-10. 다국어는 영어와 한국어, 접근성은 키보드 전용 조작, 휴대폰은 Android의 Chrome) - 배포 대상: 웹 (R-TGT-01, DR-0002에서 정한 첫 번째 대상)
MVP 다음 버전들로 미룬 것: 이름을 적는 호출 블록, 호출 블록 펴 보기 · 풀기, 접기, 블록 텍스트의 언어와 구문 강조, 테마 선택.
5.1 MVP 다음의 단계
웹은 MVP → 웹 베타 → 웹 1.0을 거칩니다 → DR-0018
| 단계 | 버전 | 누구에게 | 저장한 파일 |
|---|---|---|---|
| MVP (지금) | 0.1.0부터 | 링크를 아는 사람 | 형식이 바뀌면 뒤의 버전에서 열리지 않을 수 있다 |
| 웹 베타 | 0.y | 널리 알린다 | 같음 |
| 웹 1.0 | 1.0.0 | 모두 | 뒤의 모든 버전이 연다 |
- 웹 베타에 들어가기 전에 갖출 것: 주소, 상표 검색, 사용법, 비공개 문제 알리기 채널(R-REP-01), “1.0 전에 저장한 파일은 열리지 않을 수 있다”는 알림, 브라우저 안의 문서(R-WEB-09)
- 웹 1.0에 들어가기 전에 갖출 것: 웹의
P1기능 모두, 파일에 남는 이름과 문구, 키 표, 모든 기능을 다루는 사용법 - Obsidian 플러그인은 웹 베타 동안 베타로 시작하고(BRAT로 설치), 커뮤니티 플러그인 목록에는 웹 1.0 뒤에 올린다. 데스크톱은 그 뒤다
- 버전은 SemVer이며, 파일 형식의 버전(5. 버전 관리)과 따로 간다
5.2 MVP의 인수 기준
MVP(웹, DR-0015)를 출시하기 전에 모두 통과해야 하는 인수 테스트입니다. 유즈케이스의 기본 흐름과 우선순위가 높은 품질 속성 시나리오에서 골랐습니다. 테스트를 어떻게 쓰는지는 02-test-architecture에 있습니다.
| ID | 무엇 | 어디서 | 테스트 |
|---|---|---|---|
| AT-01 | 새 다이어그램을 만들고 블록을 삽입하고 저장한다 (UC-01 · 03 · 06) | 웹 | E2E |
| AT-02 | 저장한 파일을 다시 열면 같은 그림이다 (UC-02, QA-04) | 웹 | E2E + 골든 |
| AT-03 | 블록 6종을 삽입하고, 감싸고, 풀고, 복사하고, 분기를 삽입하고 삭제한다 (UC-03) | editor | 명령 테스트 |
| AT-04 | 키보드만으로 AT-01을 끝낸다 (QA-15) | 웹 | E2E (키 입력만) |
| AT-05 | 블록 500개 문서에서 편집 응답이 100ms 안이다 (QA-07) | 웹 | 성능 (기준 기기) |
| AT-06 | 깨진 파일을 열어도 원본은 그대로이고 편집기는 죽지 않는다 (QA-02) | core · 웹 | 퍼징 + E2E |
| AT-07 | 저장에 실패해도 편집한 내용을 잃지 않는다 (UC-06 최소 보장, QA-17) | 웹 | E2E (저장 실패를 흉내) |
| AT-08 | 저장된 그림이 플러그인 없는 뷰어(브라우저, GitHub)에서 같게 보인다 (QA-06) | 웹 · 사람 | 시각 회귀 + 점검표 |
| AT-09 | PNG로 내보낸다 (UC-08) | 웹 | E2E |
| AT-10 | 같은 문서를 Chrome · Firefox · Safari에서 저장하면 같은 바이트다 (QA-03) | 사람 | 점검표 |
| AT-11 | 드래그 앤 드롭으로 블록을 이동하고, 블록 아이콘을 끌어 놓아 삽입하고 감싼다 (UC-03) | 웹 | E2E (포인터) |
| AT-12 | 복사한 블록을 붙여넣는다: 사용자 정의 형식이면 블록 그대로, text/plain만 있으면 줄마다 처리 블록. AriadneNSD 문서인 텍스트(모델 JSON · 공유 링크)이면 새 문서로 열지 묻는다 (UC-03, R-WEB-11) | editor · 웹 | 명령 테스트 + E2E |
| AT-13 | 편집한 뒤 새로 고쳐도 로컬 백업에서 복원한다 (UC-06) | 웹 | E2E |
| AT-14 | 자동 저장(Chromium)은 원래 파일에 쓰고, Firefox에서는 저장이 내려받기다 (UC-06) | 웹 · 사람 | E2E (Chromium) + 점검표 |
| AT-15 | 최근 파일에서 다시 연다 (UC-02) | 웹 | E2E |
| AT-16 | 커맨드 팔레트에서 명령을 찾아 실행한다 | 웹 | E2E |
| AT-17 | ?로 단축키 목록을 열고, 도움말 메뉴에서 사용법을 연다 | 웹 | E2E |
- 웹에서 하는 인수 테스트(E2E)는 테스트 목록의 1장에 있고, 코드는
src/apps/web/e2e/acceptance.spec.ts에 있습니다. 테스트 이름에 AT ID를 적고(T-0004 · AT-04: …), 한 ID에 테스트가 여럿인 것도 있습니다(AT-02 · AT-04 · AT-07 · AT-14). 빌드한 앱을 Chromium으로 엽니다(pnpm e2e). - AT-05 · AT-08 · AT-10 · AT-14는 Chromium에서 확인되는 부분만 E2E입니다(AT-10 · AT-14는 테스트 이름에
(Chromium part)). 기준 기기의 성능, 다른 뷰어, Firefox · Safari는 사람이 점검표로 검증합니다(5. 도구와 CI의 출시 전). - AT-05를 기준 기기에서 측정할 때는 앱 주소에
?perf를 붙여 엽니다(https://ariadnensd.com/?perf). 앱이 블록 500개 문서를 스스로 만들어 대표 명령 8가지를 명령마다 30번 측정하고, 명령마다 중앙값 · p95 · 최댓값과 합격 여부(p95 100ms 이하), 기기 정보를 보입니다. 개발 환경은 필요 없고 아무것도 저장하지 않습니다 → 5.1 기준 기기에서 AT-05 측정하기, 9. 점검 모드
6. 미결정 사항
요구사항 관련 미결정 사항입니다. 아키텍처 관련 미결정 사항은 “제안됨” 상태의 ADR로 관리합니다. → ADR 목록
- 블록 텍스트가 지원하는 문자: 기본 블록 글꼴(D2Coding)은 라틴 · 유럽 확장, 한글, 그리스, 키릴, 가나를 포함한다(ADR-0034). 사용자는 한국어 사용자로 국한하지 않는다. 이 밖의 문자(한자, 베트남어, 아랍 · 태국 문자, 이모지)를 블록 텍스트에서 어디까지 지원할지, 문서마다 글꼴을 선택하게 할지(예: 중국어 · 일본어용 글꼴 묶음)
- Event를 트리거하는 블록: 호출 블록은 Method만 호출한다(ADR-0021). 다이어그램 안에서 다른 Event를 트리거하는 일(신호 보내기)을 그릴 블록이 따로 필요한지 → R-BLK-07
- IDE 플러그인이 다루는 언어와 왕복: 처음에 지원할 언어의 목록. 코드에는 있고 NS 다이어그램에는 없는 것(주석, 선언, 예외 처리,
break·continue)을 다이어그램에 어떻게 보이고, 다이어그램을 편집한 뒤에도 코드에 어떻게 남기는지 → 2.7 IDE 플러그인 (나중에) - 논리 · 물리 뷰의 범위: 지금의 블록 글자(
text)를 논리로 볼지 물리로 볼지, 코드에서 가져온 블록의 설명 문장을 코드의 어디(주석 등)에 남길지, 웹 · Obsidian · 데스크톱에서도 두 얼굴을 둘지 → R-IDE-08 - AI 대화창의 키 보관: 브라우저 저장소에 둔 API 키는 같은 페이지에서 실행되는 다른 스크립트(광고 R-WEB-08)가 읽을 수 있다. 광고와 한 페이지에 두어도 되는지, 탭을 닫으면 잊는 보관을 선택할 수 있게 할지 → R-WEB-07
- 쓰이지 않는 Method: 아무도 호출하지 않는 Method를 화면에서 알려 줄지 → R-BLK-11
-
nschart코드 블록의 문법: YAML, 의사 코드(if … else … end), id를 뺀 JSON 가운데 무엇으로 쓸지. YAML은 짧지만yes·no같은 키를 YAML 1.1 파서가 참 · 거짓으로 읽고, 의사 코드는 블록 글자에end같은 말이 들어갈 때의 규칙이 필요하다. 어느 쪽이든 블록의 id와 뷰 상태는 적지 않는다 → R-FMT-12 - 웹 광고의 자리: 광고 네트워크(예: Google AdSense)는 팝업·대화 상자 안의 광고를 정책으로 차단하는 경우가 많다. 저장·내보내기·공유 때만 보이게 하는 방식(R-WEB-08)을 네트워크가 허용하는지, 허용하지 않으면 광고를 어디에 둘지
참고 자료
- Wikipedia: Nassi–Shneiderman diagram
- Wikipedia (독일어): Nassi-Shneiderman-Diagramm — DIN 66261 기호 규칙
- Nassi, I. and Shneiderman, B., “Flowchart Techniques for Structured Programming”, SIGPLAN Notices 8(8), 1973 — 원 논문 (ACM)
- DIN 66261 — 1985년 독일 표준 “Sinnbilder für Struktogramme nach Nassi-Shneiderman” (유료)
- Ben Shneiderman의 NSD 페이지
- Structorizer — 오픈소스 NS 차트 편집기,
.nsd확장자 사용 - drawio-obsidian — 모델 내장 SVG 저장 방식, Obsidian 노트에 그림을 삽입하고 편집하는 방식(2.1 Obsidian 플러그인) 참고. 편집 후 노트가 갱신되지 않는 점은 따르지 않는다(R-OBS-04).
- Scratch — 이벤트 헤더 블록, 블록 묶음 참고. 하드웨어 교육에서는 Scratch 계열인 mBlock(Arduino), MakeCode(micro:bit)가 쓰인다.
- SequenceDiagram.org — 메인테이너가 꼽은 웹 버전의 본보기. 설치 없이 열리는 한 페이지 편집기이고, 사용법도 한 페이지에 모았다(R-EDIT-21).
- EasyCODE — 메인테이너가 꼽은 이상향. 요구사항의 상당 부분이 이 프로그램을 본떴다. (스크린샷)