[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
@@ -2,91 +2,122 @@
|
||||
id: wiki-2026-0508-connect-ai-documentation
|
||||
title: Connect AI Documentation
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: [P-Reinforce-AUTO-CAID-001]
|
||||
aliases: [ConnectAI documentation, AI agent documentation, system docs, SOP, API spec]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.93
|
||||
tags: [auto-reinforced, connect-ai, technical-documentation, knowledge-Architecture, user-manual, flow-Analysis, _systems-documentation]
|
||||
source_trust_level: B
|
||||
confidence_score: 0.83
|
||||
verification_status: applied
|
||||
tags: [documentation, ai-agent, sop, api-spec, knowledge-base, project-internal]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-04-20
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
language: documentation
|
||||
applicable_to: [Internal AI Agent Project, SOP, Onboarding]
|
||||
---
|
||||
|
||||
# [[Connect-AI-Documentation|Connect-AI-Documentation]]
|
||||
# Connect AI Documentation
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
> "복잡한 지능의 사용 설명서: 고도로 얽힌 AI 에이전트 시스템과 데이터 흐름을 누구나 이해하고 유지보수할 수 있게 구조화하여, 기술의 블랙박스를 투명한 '지식 지도'로 변환하는 신뢰의 기반 문서."
|
||||
## 매 한 줄
|
||||
> **"매 complex AI 의 readable 의 manual"**. 매 system architecture + SOP + API spec 의 unified. 매 modern: 매 living doc + 매 RAG 의 query-able + 매 AI 의 self-update. 매 [[Codebase_Onboarding_Guide]] 와 의 align.
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
Connect AI 기술 문서(Connect-AI-Documentation)는 복잡한 AI 에이전트 인프라와 그 운영 프로세스를 정의하고 공유하기 위한 체계적인 지식 자산입니다.
|
||||
## 매 핵심 component
|
||||
1. **System Architecture**: 매 C4 model.
|
||||
2. **SOP**: 매 step-by-step operation.
|
||||
3. **API Spec**: 매 OpenAPI / GraphQL schema.
|
||||
4. **ADR**: 매 decision record.
|
||||
5. **Glossary**: 매 term.
|
||||
6. **Runbook**: 매 incident response.
|
||||
7. **Onboarding**: 매 new dev.
|
||||
|
||||
1. **문서화의 핵심 요소**:
|
||||
* **System Architecture**: 에이전트 간의 연결망과 데이터 이동 경로 시각화. ([[Technical-Architecture|Technical-Architecture]]와 연결)
|
||||
* **[[Opera|Opera]]tional SOP**: 각 기능별 실행 단계와 리스크 대응 가이드. ([[Standard-Operating-Procedure|Standard-Operating-Procedure]]와 연결)
|
||||
* **API [[Specification|Specification]]**: 인터페이스 연결을 위한 데이터 스키마 및 가이드라인. ([[Schema|Schema]]와 연결)
|
||||
2. **왜 중요한가?**:
|
||||
* 지능형 시스템이 고도화될수록 '개념적 통일성'이 없으면 개발팀 간 소통이 단절되고 시스템이 파편화되기 때문임. ([[Terminology|Terminology]]와 연결)
|
||||
## 매 living doc 의 element
|
||||
- **CI 의 sync**: 매 stale 의 detect.
|
||||
- **RAG-queryable**: 매 LLM 의 answer.
|
||||
- **Code → doc**: 매 generate from source.
|
||||
- **Multi-format**: markdown + diagram + interactive.
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
- **과거 데이터와의 충돌**: 과거에는 정적인 PDF 파일 정책이었으나, 현대 정책은 지식 베이스(Wiki)와 동적 그래프 정책을 연동하여 시스템 변경 시 문서가 자동으로 업데이트되거나 AI 가 직접 문서를 읽고 가이드하는 '자율 업데이트형 문서 정책'을 지향함(RL Update).
|
||||
- **정책 변화(RL Update)**: 본 지식 구축 프로젝트 또한 하나의 거대한 '지능형 문서화 정책'의 일환이며, 600개의 지식을 주입하여 시스템의 두뇌 정책을 명문화하는 과정 자체가 고도의 기술 문서 체계 정책임.
|
||||
## 매 best practice
|
||||
- 매 README first.
|
||||
- 매 Diátaxis (tutorial / how-to / reference / explanation).
|
||||
- 매 minimum viable doc.
|
||||
- 매 example > prose.
|
||||
- 매 versioning.
|
||||
- 매 link > duplicate.
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
- [[Technical-Architecture|Technical-Architecture]], [[Standard-Operating-Procedure|Standard-Operating-Procedure]], [[Schema|Schema]], [[Terminology|Terminology]], Knowledge-Base
|
||||
- **Context**: Internal AI Agent Workflow, User Manuals.
|
||||
---
|
||||
## 💻 패턴
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
|
||||
- **정보 상태:** needs_review
|
||||
- **출처 신뢰도:** A
|
||||
- **검토 이유:** *(P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)*
|
||||
|
||||
## 🧬 중복 검사 (Duplicate Check)
|
||||
|
||||
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
||||
- **처리 방식:** UPDATE (자동 정규화)
|
||||
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
||||
|
||||
## 🕓 변경 이력 (Changelog)
|
||||
|
||||
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
||||
|------|-----------|-----------|--------|
|
||||
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
||||
|
||||
## 💻 코드 패턴 (Code Patterns)
|
||||
|
||||
**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
|
||||
|
||||
```text
|
||||
# TODO
|
||||
### Doc-as-code (Mintlify / Docusaurus / Astro)
|
||||
```
|
||||
docs/
|
||||
├── index.mdx
|
||||
├── architecture.mdx (C4)
|
||||
├── runbook/
|
||||
│ ├── incident-database.mdx
|
||||
│ └── incident-deploy.mdx
|
||||
├── api/
|
||||
│ └── (OpenAPI generated)
|
||||
└── onboarding.mdx
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### Living doc (CI sync check)
|
||||
```yaml
|
||||
- name: Doc drift check
|
||||
run: |
|
||||
npm run extract-types
|
||||
git diff --exit-code docs/api-types.json || \
|
||||
(echo "Doc out of sync — regenerate" && exit 1)
|
||||
```
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### RAG over docs
|
||||
```python
|
||||
from langchain.vectorstores import Chroma
|
||||
from langchain.text_splitter import RecursiveCharacterTextSplitter
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
splitter = RecursiveCharacterTextSplitter(chunk_size=1000)
|
||||
chunks = splitter.split_documents(load_md_files('docs/'))
|
||||
vectordb = Chroma.from_documents(chunks, embeddings, persist_directory='./doc-rag')
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
def ask_doc(question):
|
||||
relevant = vectordb.similarity_search(question, k=5)
|
||||
return llm.generate(f"Use these docs:\n{relevant}\n\nQuestion: {question}")
|
||||
```
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
### OpenAPI generation
|
||||
```ts
|
||||
// 매 zod-to-openapi
|
||||
import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
|
||||
extendZodWithOpenApi(z);
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
const userSchema = z.object({
|
||||
id: z.string().openapi({ example: 'uuid-...' }),
|
||||
email: z.string().email().openapi({ example: 'user@example.com' }),
|
||||
}).openapi('User');
|
||||
```
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[Documentation]] · [[Knowledge-Management]]
|
||||
- 응용: [[Codebase_Onboarding_Guide]] · [[Codebase_Maps_and_Interactive_Tours]] · [[ADR]] · [[C4_Model]]
|
||||
- Adjacent: [[Asset-Specific-Knowledge]] · [[Diátaxis]] · [[Architecture-Styles]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: 매 internal AI project 의 doc design.
|
||||
**언제 X**: 매 single-file script.
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **Stale doc**: 매 CI 의 sync 의 X.
|
||||
- **Single huge file**: 매 navigate 의 X.
|
||||
- **No examples**: 매 pure prose.
|
||||
- **Code 의 doc 의 mismatch**: 매 source-of-truth 의 ambiguous.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (Diátaxis, doc-as-code best practice).
|
||||
- 신뢰도 B.
|
||||
- Related: [[Codebase_Onboarding_Guide]] · [[Codebase_Maps_and_Interactive_Tours]] · [[Asset-Specific-Knowledge]].
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — components + 매 doc-as-code / RAG / OpenAPI code |
|
||||
|
||||
Reference in New Issue
Block a user