문서 컨벤션
여러 도구(Obsidian, GitHub, Quartz, AI)가 같은 파일을 읽으므로 아래 규칙을 지킨다. Linter 플러그인과 CI가 대부분 자동으로 잡아준다.
링크
- 표준 마크다운 링크만 사용:
[ADR-0001](../adr/0001-docs-as-code-hybrid.md) [[위키링크]]금지 — GitHub와 일부 도구에서 깨진다.- Obsidian 설정: Settings → Files & Links → “Use Wikilinks” 끄기
- 상대 경로 사용, 확장자
.md까지 포함 - 외부 링크는 전체 URL
파일명
- 케밥케이스, 한글 가능하지만 영문 권장:
payment-redesign.md - ADR:
NNNN-제목.md(4자리 번호) - 회의록:
YYYY-MM-DD-주제.md - 공백·특수문자 금지
Frontmatter (필수)
모든 문서 상단에 YAML frontmatter를 쓴다. Dataview가 이걸 읽어 인덱스를 자동 생성한다.
---
type: adr | design | prd | runbook | postmortem | meeting | api | reference
status: draft | in-review | approved | implemented | accepted | superseded | deprecated
date: YYYY-MM-DD
owner: 이름
---첨부파일
- 모든 이미지·첨부는
docs/assets/아래에:docs/assets/{문서명}/{파일명} - Obsidian 설정: Settings → Files & Links → Attachment folder →
docs/assets - 다이어그램 우선순위: Mermaid(텍스트) > Excalidraw(.excalidraw.md) > 이미지 캡처
- 텍스트일수록 diff가 남고 AI가 읽을 수 있다
개인 노트
- 개인 메모는 이 vault에 두지 않는다. 개인 vault를 따로 쓸 것
- 실수로 커밋되는 것을 막기 위해
_private/폴더는 gitignore 되어 있다