Skip to main content

InfoLineage Docs — Claude Code Guidelines

Purpose of this session​

This directory(idocs/docs/) isInfoLineage Team Documentation Dedicated Docusaurus Projectis.infolineage-platformIt is managed as a separate git repo from the source code repo.

If you opened Claude Code to this directory root, this is a session for document creation/modification/updating.

Git Information​

itemvalue
Remotehttps://Security365@dev.azure.com/Security365/InfoLineage/_git/docs
default branchmain
Physical Path~/wsl-repo/infolineage-platform/idocs/docs/
# 작업 전 최신 동기화
git pull origin main

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

Platform source code reference​

When you need to refer to the source code in API specification updates, etc.:

../../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 프론트엔드

CLAUDE.md of the Platform repo../../CLAUDE.mdIt contains details on architecture, coding conventions, and technology stack.

Directory Structure​

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 Syntax Rules​

Frontmatter (Required)​

all.mdYAML frontmatter at the top of the file:

---
sidebar_position: 1
---

Category Settings​

Each directory's_category_.jsonSpecify sidebar order/label:

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

Markdown Precautions​

  • When specifying generic types\<, \>Escape needed:List\<string\>
  • within the table|Character\|Escape
  • within code block{, }— Can be interpreted as an MDX component, so use only within code fences (```)
  • Relative link: within the same directory[제목](./파일명.md), upper[제목](../경로/파일.md)

New Document Addition Checklist​

  1. in the frontmattersidebar_positiondesignate
  2. in the directory_category_.jsonExistence Check
  3. The file name isNN_제목.mdPattern (ex:01_API_엔드포인트_목록.md)
  4. Korean file names are allowed (git supports UTF-8)

Commit Message Convention​

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