2.1 KiB
2.1 KiB
id, category, confidence_score, tags, last_reinforced
| id | category | confidence_score | tags | last_reinforced | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| P-REINFORCE-AUTO-DOST-001 | 10_Wiki/💡 Topics/AI | 0.90 |
|
2026-04-20 |
Documentation-Strategy
📌 한 줄 통찰 (The Karpathy Summary)
"지식의 영속성 확보: 코드가 '어떻게' 작동하는지를 넘어, '왜' 그렇게 설계되었는지와 사용법을 명확히 기록함으로써 팀의 인지 부하를 줄이고 지능의 단절 없는 공유를 보장하는 전략적 관리 활동."
📖 구조화된 지식 (Synthesized Content)
문서화 전략(Documentation-Strategy)은 정보의 가독성, 최신성, 유용성을 유지하기 위한 계획입니다.
- 4가지 문서 유형 (Diátaxis framework):
- Tutorials: 학습자 중심의 실제 따라하기 (Learning-oriented).
- How-to Guides: 특정 문제를 해결하기 위한 스텝 (Goal-oriented).
- Reference: API 규격 등 기술적 상세 정보 (Information-oriented).
- Explanation: 설계 배경과 개념적 논의 (Understanding-oriented).
- 왜 중요한가?:
- 팀원이 떠나도 지식이 유실되지 않으며, 새로운 팀원이 빠르게 온보딩할 수 있음. (Cognitive Biases 중 지식의 저주 방지)
⚠️ 모순 및 업데이트 (Contradictions & RL Update)
- 과거 데이터와의 충돌: 과거에는 두꺼운 '매뉴얼 책자 정책'이었으나, 현대 정책은 코드와 함께 살아있는 'Docs as Code 정책'과 검색이 용이한 'Wiki 기반 지식 기지 정책'으로 진화함(RL Update). (이 Obsidian Wiki가 그 정점)
- 정책 변화(RL Update): AI가 코드를 읽고 문서를 자동으로 초안 작성하거나, 문서만 보고 동작하는 코드를 생성하는 '상호 보완적 문서화 정책'이 개발 문화의 중심이 됨.
🔗 지식 연결 (Graph)
- Concept Mapping, Clean-Architecture-TypeScript, Knowledge synthesis, Cognitive Biases, Analysis
- Modern Tech/Tools: Markdown, Docusaurus, Read the Docs, Notion/Obsidian.