Files
2nd/10_Wiki/Topic_Programming/AI_and_ML/Connect-AI-Documentation.md
T
Antigravity Agent 9148c358d0 docs(10_Wiki): 위키 전체 재구성 — Topic_* 폴더를 4개 카테고리로 통합 + 대규모 중복 제거
Topic_Agent/Topic_Blog/Topics/Topics_Biz/Topics_Meeting/Topics_Rag의 마크다운 지식 문서를
Topic_General/Topic_Programming/Topic_Graphic/Topic_Business 4개 카테고리로 재분류.

- 중복 제거: frontmatter의 status:duplicate/merged + duplicate_of/redirect_to 필드로
  자기 자신을 중복으로 선언한 리다이렉트 stub 1032개 제거, 완전 동일 내용 파일 472개 제거,
  동일 파일명·다른 내용 충돌 시 더 큰(완전한) 버전만 유지(162개 제거) — 총 1639개 중복 제거.
- 분류: 폴더 단위로 명확한 항목(AI_and_ML/Coding/Architecture 등 → Programming,
  Comfyui/Visual_Effects → Graphic, Topics_Biz/Topics_Meeting/사업 등 → Business,
  Poetic_Blog_Writing/창의성/Game_Design 등 → General)은 폴더 우선순위로,
  나머지 혼재 폴더(Topic_Agent/Topic_Blog/Topics 루트/Thinking & Reasoning/Other/UI_UX_Assets)는
  title/tags 키워드 스코어링으로 파일 단위 분류(불명확한 경우 General로 폴백).
  원본 폴더명은 "From_*" 서브폴더로 보존해 추적 가능성 유지.
- 최종 배치: Programming 2784 / General 1608 / Graphic 285 / Business 249 = 4926개 문서.
- 에이전트 운영 상태(.astra/.agent/.obsidian/sessions/memory/_company/docs/lessons/_shared/src)는
  지식 콘텐츠가 아니므로 재분류 대상에서 제외하고 원위치 유지.
- Topics/Topic_email(상위 보호 폴더 Topic_email과 파일명 100% 중복) 삭제 — 보호 폴더 자체는 미변경.
- 완전히 비게 된 Topic_Agent/Topic_Blog/Topics_Biz/Topics_Rag 폴더 제거.
2026-07-05 00:33:48 +09:00

3.7 KiB

id, title, category, status, canonical_id, aliases, duplicate_of, source_trust_level, confidence_score, verification_status, tags, raw_sources, last_reinforced, github_commit, tech_stack
id title category status canonical_id aliases duplicate_of source_trust_level confidence_score verification_status tags raw_sources last_reinforced github_commit tech_stack
wiki-2026-0508-connect-ai-documentation Connect AI Documentation 10_Wiki/Topics verified self
ConnectAI documentation
AI agent documentation
system docs
SOP
API spec
none B 0.83 applied
documentation
ai-agent
sop
api-spec
knowledge-base
project-internal
2026-05-10 pending
language applicable_to
documentation
Internal AI Agent Project
SOP
Onboarding

Connect AI Documentation

매 한 줄

"매 complex AI 의 readable 의 manual". 매 system architecture + SOP + API spec 의 unified. 매 modern: 매 living doc + 매 RAG 의 query-able + 매 AI 의 self-update. 매 Codebase_Onboarding_Guide 와 의 align.

매 핵심 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.

매 living doc 의 element

  • CI 의 sync: 매 stale 의 detect.
  • RAG-queryable: 매 LLM 의 answer.
  • Code → doc: 매 generate from source.
  • Multi-format: markdown + diagram + interactive.

매 best practice

  • 매 README first.
  • 매 Diátaxis (tutorial / how-to / reference / explanation).
  • 매 minimum viable doc.
  • 매 example > prose.
  • 매 versioning.
  • 매 link > duplicate.

💻 패턴

Doc-as-code (Mintlify / Docusaurus / Astro)

docs/
├── index.mdx
├── architecture.mdx (C4)
├── runbook/
│   ├── incident-database.mdx
│   └── incident-deploy.mdx
├── api/
│   └── (OpenAPI generated)
└── onboarding.mdx

Living doc (CI sync check)

- 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)

RAG over docs

from langchain.vectorstores import Chroma
from langchain.text_splitter import RecursiveCharacterTextSplitter

splitter = RecursiveCharacterTextSplitter(chunk_size=1000)
chunks = splitter.split_documents(load_md_files('docs/'))
vectordb = Chroma.from_documents(chunks, embeddings, persist_directory='./doc-rag')

def ask_doc(question):
    relevant = vectordb.similarity_search(question, k=5)
    return llm.generate(f"Use these docs:\n{relevant}\n\nQuestion: {question}")

OpenAPI generation

// 매 zod-to-openapi
import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
extendZodWithOpenApi(z);

const userSchema = z.object({
  id: z.string().openapi({ example: 'uuid-...' }),
  email: z.string().email().openapi({ example: 'user@example.com' }),
}).openapi('User');

🔗 Graph

🤖 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.

🧪 검증 / 중복

🕓 Changelog

날짜 변경
2026-05-08 Phase 1
2026-05-10 Manual cleanup — components + 매 doc-as-code / RAG / OpenAPI code