メインコンテンツまでスキップ

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

プラットフォームソースコード参照​

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の文法ルール​

フロントマター (必須)​

すべて.mdファイルの最上部にYAMLフロントマター:

---
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): 설명           # 로그 스펙/기획 문서