본문으로 건너뛰기

InfoLineage Docs — Claude Code 지침서

이 세션의 용도​

이 디렉토리(idocs/docs/)는 InfoLineage 팀 문서 전용 Docusaurus 프로젝트입니다. infolineage-platform 소스코드 repo와 별도의 git repo로 관리됩니다.

Claude Code를 이 디렉토리 루트로 열었다면, 문서 작성/수정/현행화 작업을 위한 세션입니다.

Git 정보​

항목값
Remotehttps://Security365@dev.azure.com/Security365/InfoLineage/_git/docs
기본 브랜치main
물리 경로~/wsl-repo/infolineage-platform/idocs/docs/
# 작업 전 최신 동기화
git pull origin main

# 커밋 & 푸시
git add <파일>
git commit -m "docs: 설명"
git push origin main

Platform 소스코드 참조​

API 명세 현행화 등에서 소스코드를 참조해야 할 때:

../../backend/infolineage-api/src/main/java/com/infolineage/api/controller/   ← REST Controllers
../../backend/infolineage-common/src/main/java/com/infolineage/common/        ← 공통 DTO, Port
../../frontend/src/                                                            ← Vue 3 프론트엔드

Platform repo의 CLAUDE.md(../../CLAUDE.md)에 아키텍처, 코딩 컨벤션, 기술 스택 상세가 있음.

디렉토리 구조​

docs/
├── 01. Product_Info/       # 제품 소개
├── 02. Product_Spec/       # 제품 스펙
├── 03. Knowledge_Base/     # 지식 베이스
├── 04. Guide/              # 사용 가이드
├── 05. Deployment/         # 배포 가이드
├── 06. Internal/           # 내부 문서
│   ├── 01. Planning/       #   기획 (usecase, 로그 스펙)
│   └── 02. Development/    #   개발
│       └── 05.Platform/    #     InfoLineage Platform
│           ├── 01.Architecture/
│           ├── 02.Backend/
│           ├── 03.Frontend/
│           ├── 04.API/         ← API 명세
│           └── 05.Infra/
└── Img/                    # 이미지 리소스

Docusaurus 문법 규칙​

Frontmatter (필수)​

모든 .md 파일 최상단에 YAML frontmatter:

---
sidebar_position: 1
---

카테고리 설정​

각 디렉토리의 _category_.json으로 사이드바 순서/레이블 지정:

{
  "label": "API Reference",
  "position": 4,
  "link": {
    "type": "generated-index",
    "description": "REST API 명세 및 엔드포인트 가이드"
  }
}

마크다운 주의사항​

  • 제네릭 타입 표기 시 \<, \> 이스케이프 필요: List\<string\>
  • 테이블 내 | 문자는 \|로 이스케이프
  • 코드 블록 내 {, } — MDX 컴포넌트로 해석될 수 있으므로 코드펜스(```) 안에서만 사용
  • 상대 링크: 같은 디렉토리 내 [제목](./파일명.md), 상위 [제목](../경로/파일.md)

새 문서 추가 체크리스트​

  1. frontmatter에 sidebar_position 지정
  2. 디렉토리에 _category_.json 존재 확인
  3. 파일명은 NN_제목.md 패턴 (ex: 01_API_엔드포인트_목록.md)
  4. 한글 파일명 사용 가능 (git은 UTF-8 지원)

커밋 메시지 컨벤션​

docs: 간결한 설명          # 일반 문서 추가/수정
docs(platform): 설명       # Platform 관련 문서
docs(spec): 설명           # 로그 스펙/기획 문서