문서

NS 차트(Nassi-Shneiderman Diagram)를 그리는 프로그램입니다. 웹(정적 페이지), Obsidian 플러그인, 데스크톱 앱을 먼저 만들고, 그 위에 Google Drive · Confluence · IDE 플러그인 · Claude skill이 연동됩니다 → 2. 배포 대상.

이 폴더에는 지금의 모습만 둡니다: 무엇을 만드는지, 사용자에게 어떻게 보이는지, 어떻게 만드는지. 거기에 이르기까지의 결정 기록(아키텍처는 ADR, 그 밖은 DR)과 논의는 atelier/에 있습니다. → 아뜰리에

문서 지도

폴더마다 읽는 순서대로 번호를 붙였습니다. 요구사항이 UX 설계와 아키텍처의 입력이고, 이 둘이 상세 설계의 입력입니다. 파일 형식 명세는 상세 설계에서 나옵니다. 지도의 모양은 시안 M31에서 선택했습니다(→ sketchbook).

flowchart LR
  R["01 요구사항<br/>무엇을 만드나"] --> U["02 UX 설계<br/>어떻게 보이고 움직이나"]
  R --> A["03 아키텍처<br/>어떤 구조로"]
  U --> D["04 상세 설계<br/>세부적으로 어떻게"]
  A --> D
  D --> S["05 명세<br/>파일은 정확히 어떻게"]
  G["06 용어집<br/>이 단어가 무슨 뜻인가"]
  A --> C["07 코딩 가이드<br/>코드를 어떻게 쓰나"]
  D --> C

01 요구사항: 무엇을 만드나?

문서답하는 질문상태바뀌는 때
요구사항무엇을 만드나?초안계속
유즈케이스사용자는 무엇을 이루려고 그 기능들을 잇달아 쓰나?초안요구사항과 함께
품질 속성 시나리오비기능 요구사항을 어떻게 측정하고, 어느 구조와 테스트가 담당하나?초안요구사항 · 아키텍처와 함께

02 UX 설계: 어떻게 보이고 움직이나?

문서답하는 질문상태바뀌는 때
UX 개요누구를 위해, 어떤 원칙으로? 공통 규칙은?초안원칙이 바뀔 때
조작 규칙기능 하나하나가 어떻게 움직이나?초안계속
단축키어떤 키가 어떤 명령인가?초안써 보며
시각 디자인색 · 선 · 타이포그래피 · 치수는? 그렇게 정한 원칙은?초안시안으로 정하며
화면 배치편집 화면에 무엇이 어디에 있나? 메뉴 바 · 툴바 · 캔버스 · 상태 표시줄, 좁은 화면, 설정 창, 도움말초안화면이 바뀔 때

03 아키텍처: 어떤 구조로 만드나?

문서답하는 질문상태바뀌는 때
아키텍처 개요전체 구조는? 실행 중에 어떤 컴포넌트가 활성 상태이고 어떻게 통신하나? 모듈은 무엇이고 어떻게 연결되나? 어떤 기술과 라이브러리를 쓰나(9장)?초안계속
테스트 아키텍처테스트 아키텍처(유형 · 테스트 더블 · 추적), 계층마다 무엇을 테스트하나? 골든 파일, MVP의 인수 테스트, 도구와 CI는?초안구현과 함께

04 상세 설계: 세부적으로 어떻게?

문서답하는 질문상태바뀌는 때
모델문서 모델(다이어그램 여럿, 뷰 상태), 노드 타입, 불변 조건, 편집 명령은? 구조는 01-architecture에 먼저 있음작성 중구현과 함께
레이아웃 · 렌더링크기와 자리는 어떻게 계산하나? 텍스트 폭(번들 글꼴), SVG 렌더링, 내보내기는? 모습의 값은 04-visual-design작성 중구현과 함께
편집기화면 레이어, 상태와 선택, 입력→명령, 드래그 앤 드롭 · 클립보드, 메뉴, 셸 인터페이스는?초안구현과 함께
Obsidian 플러그인Obsidian 셸은 어떻게 구성하나?작성 전구현과 함께
데스크톱 앱데스크톱 셸은 어떻게 구성하나?작성 전구현과 함께
웹웹 셸은 어떻게 구성하나?초안구현과 함께
Claude skillClaude skill의 스크립트는 무엇을 입력받아 무엇을 생성하나? 앱과 같은 결과는 어떻게 보장하나? 어떻게 번들하고 배포하나?초안구현과 함께
테스트 목록지금 코드에 있는 테스트는 기능 영역마다 무엇이고, 무엇을 근거로 하나? 테스트가 없는 시나리오는? (스크립트가 만듦)생성됨테스트와 함께(pnpm check가 확인)

05 명세: 파일은 정확히 어떻게 생겼나?

문서답하는 질문상태바뀌는 때
파일 형식 명세저장되는 .ns · .ns.svg 파일은 정확히 어떻게 생겼나?초안형식 버전이 바뀔 때만
모델 JSON 스키마모델 JSON의 객체마다 어떤 필드가 있고 무슨 값을 받나? 스키마가 보지 못하는 규칙은? (스크립트가 JSON Schema에서 만듦)생성됨스키마와 함께

06 용어집: 이 단어가 무슨 뜻인가?

문서답하는 질문상태바뀌는 때
용어집문서에 나오는 단어가 무슨 뜻인가?필요할 때 더함

07 코딩 가이드: 코드를 어떻게 쓰나?

문서답하는 질문상태바뀌는 때
코딩 가이드도구는 무엇을 강제하고 어떻게 설정하나? 이름 · 구조 · 오류 처리 · 주석 · 테스트 · 커밋은 어떻게 쓰나?초안도구 설정과 함께

문서를 쓸 때의 원칙

  • 요구사항에는 무엇을만 한두 줄로 쓰고, 세부 규칙은 UX 설계로, 근거는 ADR이나 DR로, 만드는 방법은 설계 문서로 링크합니다.
  • 요구사항 항목은 ID(R-EDIT-06 등)로 가리킵니다. 예: R-EDIT-06
  • 왜 그렇게 정했는지는 결정 기록에 있습니다. 아키텍처 결정은 ADR(atelier/adr/), 그 밖의 결정은 DR(atelier/decisions/)이고, 목록은 ADR 목록과 DR 목록에 있습니다.

7건의 항목