refactor: 분리되어 관리하고 있던 문서 시스템을 하나로 통일
This commit is contained in:
@@ -0,0 +1,49 @@
|
||||
---
|
||||
id: <Studio 가 준 uuid. 아직 없으면 빈 값>
|
||||
kind: CASE
|
||||
slug: <slug>
|
||||
title: <제목>
|
||||
topic: <주제 이름>
|
||||
project: <프로젝트 이름>
|
||||
status: 게시 전
|
||||
studio: "<편집 화면 주소. 아직 없으면 빈 값>"
|
||||
lastVerifiedOn: <실제로 확인한 날 또는 빈 값>
|
||||
assets:
|
||||
- key: <본문의 :::evidence key 와 같은 값>
|
||||
file: <../../../final/assets/… 상대 경로>
|
||||
evidence:
|
||||
- <../../../final/evidence/raw/… 상대 경로>
|
||||
---
|
||||
|
||||
# <title>
|
||||
|
||||
<summary>
|
||||
|
||||
## 관계
|
||||
|
||||
- **<related record>**
|
||||
<why related>
|
||||
|
||||
## 문제
|
||||
|
||||
<concrete observed problem and scope>
|
||||
|
||||
## 결론
|
||||
|
||||
<bounded conclusion supported by evidence>
|
||||
|
||||
## 검증 환경
|
||||
|
||||
<plain text exact environment>
|
||||
|
||||
## 재현 조건
|
||||
|
||||
<ordered concrete conditions/steps>
|
||||
|
||||
## 본문
|
||||
|
||||
<!-- body:start -->
|
||||
|
||||
<rich Case body>
|
||||
|
||||
<!-- body:end -->
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: <Studio 가 준 uuid. 아직 없으면 빈 값>
|
||||
kind: CONCEPT
|
||||
slug: <slug>
|
||||
title: <제목>
|
||||
topic: <주제 이름>
|
||||
project: <프로젝트 이름>
|
||||
status: 게시 전
|
||||
studio: "<편집 화면 주소. 아직 없으면 빈 값>"
|
||||
basisVersion: <무엇을 보고 썼는지. 예 Keycloak 26.7.0 · oidc-client-ts 3.3.0>
|
||||
assets:
|
||||
- key: <본문의 :::evidence key 와 같은 값>
|
||||
file: <../../../final/assets/… 상대 경로>
|
||||
evidence:
|
||||
- <../../../final/evidence/raw/… 상대 경로>
|
||||
---
|
||||
|
||||
# <제목>
|
||||
|
||||
<요약. 이 개념이 무엇을 어떻게 하는지 한 문단>
|
||||
|
||||
## 관계
|
||||
|
||||
- **<이어지는 기록>**
|
||||
<왜 이어지는지>
|
||||
|
||||
## 본문
|
||||
|
||||
<!-- body:start -->
|
||||
|
||||
## <무엇이 무엇을 주고받나>
|
||||
|
||||
<첫 절은 참여자와 오가는 것을 세운다>
|
||||
|
||||
## <단계마다 실제로 일어나는 일>
|
||||
|
||||
## <그 설계가 막지 않는 것>
|
||||
|
||||
## <지금 확인한 범위>
|
||||
|
||||
<규격이 정한 것과 이 구현이 그렇게 한 것을 구분한다. 「확인했다」는 Case 의 말이라 쓰지 않는다>
|
||||
|
||||
<!-- body:end -->
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: <Studio 가 준 uuid. 아직 없으면 빈 값>
|
||||
kind: PROJECT_DECISION
|
||||
slug: <slug>
|
||||
title: <제목>
|
||||
topic: <주제 이름>
|
||||
project: <프로젝트 이름>
|
||||
status: 게시 전
|
||||
studio: "<편집 화면 주소. 아직 없으면 빈 값>"
|
||||
decisionStatus: PROPOSED
|
||||
assets:
|
||||
- key: <본문의 :::evidence key 와 같은 값>
|
||||
file: <../../../final/assets/… 상대 경로>
|
||||
evidence:
|
||||
- <../../../final/evidence/raw/… 상대 경로>
|
||||
---
|
||||
|
||||
# <title>
|
||||
|
||||
<summary>
|
||||
|
||||
## 근거
|
||||
|
||||
- **<Case or Reference>**
|
||||
<how it grounds this decision>
|
||||
|
||||
## 결정문
|
||||
|
||||
<the actual project choice>
|
||||
|
||||
## 판단 이유
|
||||
|
||||
<only rationale explicitly supported by decision evidence>
|
||||
|
||||
## 영향
|
||||
|
||||
- <grounded consequence/trade-off>
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
id: <Studio 가 준 uuid. 아직 없으면 빈 값>
|
||||
kind: QUESTION
|
||||
slug: <slug>
|
||||
title: <제목>
|
||||
topic: <주제 이름>
|
||||
project: <프로젝트 이름>
|
||||
status: 게시 전
|
||||
studio: "<편집 화면 주소. 아직 없으면 빈 값>"
|
||||
questionStatus: OPEN
|
||||
assets:
|
||||
- key: <본문의 :::evidence key 와 같은 값>
|
||||
file: <../../../final/assets/… 상대 경로>
|
||||
evidence:
|
||||
- <../../../final/evidence/raw/… 상대 경로>
|
||||
---
|
||||
|
||||
# <title>
|
||||
|
||||
<summary of unresolved issue>
|
||||
|
||||
## 관계
|
||||
|
||||
- **<related record>**
|
||||
<why related>
|
||||
|
||||
## 사실
|
||||
|
||||
- <grounded fact>
|
||||
|
||||
## 가정
|
||||
|
||||
- <explicit assumption, if any>
|
||||
|
||||
## 미지수
|
||||
|
||||
- <unknown>
|
||||
|
||||
## 제약
|
||||
|
||||
- <constraint>
|
||||
|
||||
## 선택지
|
||||
|
||||
### 1. <grounded candidate, only when it really exists>
|
||||
|
||||
<what is known and what must be checked>
|
||||
|
||||
## 다음 검증
|
||||
|
||||
1. <next concrete verification>
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
id: <Studio 가 준 uuid. 아직 없으면 빈 값>
|
||||
kind: REFERENCE
|
||||
slug: <slug>
|
||||
title: <제목>
|
||||
topic: <주제 이름>
|
||||
project: <프로젝트 이름>
|
||||
status: 게시 전
|
||||
studio: "<편집 화면 주소. 아직 없으면 빈 값>"
|
||||
assets:
|
||||
- key: <본문의 :::evidence key 와 같은 값>
|
||||
file: <../../../final/assets/… 상대 경로>
|
||||
evidence:
|
||||
- <../../../final/evidence/raw/… 상대 경로>
|
||||
---
|
||||
|
||||
# <title>
|
||||
|
||||
<summary>
|
||||
|
||||
## 관계
|
||||
|
||||
- **<related record>**
|
||||
<why related>
|
||||
|
||||
## 목적
|
||||
|
||||
<why this reusable criterion exists>
|
||||
|
||||
## 규칙
|
||||
|
||||
### 1. <rule title>
|
||||
|
||||
<plain-text rule>
|
||||
|
||||
## 적용 조건
|
||||
|
||||
- <condition>
|
||||
|
||||
## 예외
|
||||
|
||||
- <exception or explicitly none>
|
||||
|
||||
## 예시
|
||||
|
||||
- <plain-text example>
|
||||
Reference in New Issue
Block a user