Documentation System
Documentation System
Section titled “Documentation System”my-lab의 문서 체계는 개인 지식 데이터베이스와 포트폴리오 정리본을 분리합니다.
vault/private: 아이디어, 학습 기록, 시행착오, 패치노트vault/public: 공개 가능한 정리본apps/docs:vault/public을 발행하는 Astro 사이트
apps/docs/src/content/docs는 원본 작성 위치가 아니라 pnpm sync:content로 생성되는 발행 트리입니다.
Knowledge Graph
Section titled “Knowledge Graph”private Vault에서는 프로젝트 문서와 패치노트를 Obsidian 링크로 연결합니다.
- 프로젝트 개요
- 로드맵
- 아키텍처
- 의사결정
- 작업 단위 패치노트
- 라이브러리 학습 노트
Patch Note
Section titled “Patch Note”개발 기록은 작업 단위로 남깁니다.
각 패치노트는 다음 순서를 따릅니다.
- Idea
- Planning
- Implementation
- Issues
- Resolution
- Verification
- Follow-up
이 형식은 어떤 아이디어가 있었고, 어떤 계획을 세웠고, 실제 구현 중 어떤 문제가 있었는지 추적하기 위한 기준입니다.
Publishing
Section titled “Publishing”공개 문서는 private 원장을 그대로 노출하지 않습니다.
공개할 내용은 vault/public에 별도 정리본으로 작성하고, Docs 빌드 전에 pnpm sync:content로 반영합니다.