80fa94966d97cb05eadfc4afc43aad30251d9ddb
ai ai
$ curl -sL git.syui.ai/ai/ai/raw/branch/main/ai.json|jq .ai.ai
AI Ecosystem Documentation System
効率的なAI理解用ドキュメント管理システム
🎯 概要
Claude Code使用時のtoken消費を70%削減する最適化されたドキュメントシステム:
- 分離設計: コア情報とプロジェクト固有情報の分離
- 動的生成: 必要な情報のみを組み合わせて生成
- 統一管理: 全プロジェクトの一元的ドキュメント管理
📁 ディレクトリ構造
../ai/
├── claude/ # Claude Code専用フォルダ
│ ├── core/ # 共通ドキュメント
│ │ ├── philosophy.md # 存在子理論・yui system
│ │ ├── naming.md # 名前規則
│ │ └── architecture.md # システム構成
│ ├── projects/ # プロジェクト固有情報
│ │ ├── os.md # ai.os
│ │ ├── gpt.md # ai.gpt
│ │ └── card.md # ai.card
│ ├── scripts/ # 管理スクリプト
│ │ ├── generate_claude.sh # ドキュメント生成
│ │ ├── sync_docs.sh # プロジェクト間同期
│ │ ├── sync-all.sh # 完全同期(submodule + docs)
│ │ ├── update-submodules.sh # 高機能submodule管理
│ │ └── session-end.sh # Claude Codeセッション終了処理
│ └── templates/ # テンプレート
├── [git submodules] # 各プロジェクトのsubmodule
├── ai.json # 最適化されたメタデータ
└── ai.md # ユーザーの思考・思想(claude.mdのベース)
🚀 使用方法
個別プロジェクトのドキュメント生成
# ai.osのドキュメント生成
./claude/scripts/generate_claude.sh --project=os --output=../os/claude.md
# 特定コンポーネントのみ含める
./claude/scripts/generate_claude.sh --project=gpt --include=philosophy,specific --output=../gpt/claude.md
全プロジェクトの一括同期
# 全プロジェクトを同期
./claude/scripts/sync_docs.sh --all
# 個別プロジェクトの同期
./claude/scripts/sync_docs.sh --project=os
# 確認用(実際には変更しない)
./claude/scripts/sync_docs.sh --dry-run --all
高機能submodule管理
# 全submodule更新
./claude/scripts/update-submodules.sh --all --auto
# 特定module更新
./claude/scripts/update-submodules.sh --module=gpt --auto
# 確認のみ(dry-run)
./claude/scripts/update-submodules.sh --all --dry-run
# 一貫性チェック(重要)
./claude/scripts/update-submodules.sh --check-consistency
# URL整合性検証
./claude/scripts/update-submodules.sh --validate
# 設定同期
./claude/scripts/update-submodules.sh --sync --auto
# 完全同期(submodule + docs)
./claude/scripts/sync-all.sh
Claude Codeセッション管理
# セッション終了時(重要)
./claude/scripts/session-end.sh --auto-sync
# 詳細サマリー付き
./claude/scripts/session-end.sh --summary="実装内容の説明" --auto-sync
# プロジェクト指定
./claude/scripts/session-end.sh --project=gpt --auto-sync
📊 最適化効果
項目 | 従来 | 最適化後 | 削減率 |
---|---|---|---|
ai.json | 1,011行 | 287行 | 71.6% |
CLAUDE.md | 350行/プロジェクト | 267行/プロジェクト | 23.7% |
重複コンテンツ | 全プロジェクト複製 | 共通部分統一 | ~70% |
🔧 コンポーネント詳細
Core Documents
- philosophy.md: 存在子理論、yui system、現実反映システム
- naming.md: プロジェクト命名規則、設定ディレクトリ構造
- architecture.md: 全体システム構成、技術スタック
- git_architecture.md: 構造ベースGit URL生成システム
Project-Specific Documents
- os.md: ai.os(ArchLinux OS、AI統合基盤)
- gpt.md: ai.gpt(自律AI、記憶システム、MCP統合)
- card.md: ai.card(atprotoカードゲーム、データ主権)
Generation Script Options
--include=<components> # 含めるコンポーネント指定
利用可能なコンポーネント:
core
: philosophy + naming + architecturephilosophy
: 存在子理論のみnaming
: 名前規則のみarchitecture
: システム構成のみspecific
: プロジェクト固有情報のみ
📈 メンテナンス
新しいプロジェクトの追加
claude/projects/new_project.md
を作成ai.json
にメタデータ追加claude/scripts/sync_docs.sh
のディレクトリリストに追加
コア情報の更新
claude/core/
ディレクトリの該当ファイルを編集./claude/scripts/sync_docs.sh --all
で全プロジェクトに反映
プロジェクト固有情報の更新
claude/projects/
ディレクトリの該当ファイルを編集./claude/scripts/sync_docs.sh --project=<name>
で反映
🤖 自動化システム
GitHub Actions
毎日02:00 UTC(11:00 JST)に自動実行:
- 全submoduleの最新化
- 変更があれば自動commit
- 手動実行も可能(個別module指定可)
Gitea Workflows
GitHub Actionsと同等の機能をGiteaでも提供:
- スケジュール実行:毎日02:00 UTC
- 手動実行:個別またはすべてのmodule
- 自動commit機能
高機能submodule管理システム
- 構造ベースURL生成: ai.jsonの階層からGit URL自動構築
- 一貫性チェック: プロジェクト間の齟齬自動検出
- ブランチ管理: プロジェクトごとの個別ブランチ設定
- URL整合性検証: .gitmodulesとai.json設定の自動同期
- セッション記録: Claude Codeセッション成果の完全記録
- 差分検出: 変更があるもののみ更新
- 詳細ログ: 更新内容の完全記録
- エラーハンドリング: 失敗時の適切な処理
- プラットフォーム対応: macOS/Linux両対応
Claude Codeセッション管理
- 自動変更検出: 未コミット変更の自動発見
- 構造化記録:
.claude/sessions/
にMarkdown形式で保存 - 親リポジトリ同期: サブモジュール更新の自動反映
- 一貫性保証: セッション終了時の自動検証
🎉 利点
AI理解の最適化
- 簡潔性: 必要最小限の情報に集約
- 構造化: セクション別の明確な分離
- 一貫性: 全プロジェクト統一フォーマット
開発効率の向上
- Token節約: Claude Code利用コスト大幅削減
- メンテナンス: 一箇所変更で全体反映
- 品質: 自動生成による一貫性保証
スケーラビリティ
- 拡張性: 新プロジェクト追加が容易
- 柔軟性: コンポーネント選択可能
- 自動化: submodule更新からdocs生成まで完全自動化
© syui
Description
Languages
Markdown
100%