多言語ドキュメント構成

[!NOTE] 最新の実装状況は 機能実装ステータス (Remaining Functionality) を参照してください。

EvoSpikeNetドキュメントサイトは日本語と英語の両言語に対応しています。

📚 言語別ドキュメント

日本語版（デフォルト）

• ファイル形式: filename.md
• URL: https://evospikenet.readthedocs.io/
• 対象: 日本語話者

英語版

• ファイル形式: filename.en.md
• URL: https://evospikenet.readthedocs.io/en/
• 対象: 英語話者

🌐 利用可能な英語版ドキュメント

コアドキュメント

日本語	英語	状態
index.md	index.en.md	✅ 完成
overview.md	overview.en.md	✅ 完成
features.md	features.en.md	🔄 作成中
faq.md	faq.en.md	🔄 作成中
getting-started/quickstart.md	getting-started/quickstart.en.md	✅ 完成

実装ノート（アーティファクト）: ドキュメントのアーティファクト仕様（artifact_manifest.json）と CLI フラグは docs/implementation/ARTIFACT_MANIFESTS.md を参照してください。

概念・システムドキュメント

日本語	英語	状態
EVOSPIKENET_CONCEPTS.md	EVOSPIKENET_CONCEPTS.en.md	✅ 存在
DISTRIBUTED_BRAIN_SYSTEM.md	DISTRIBUTED_BRAIN_SYSTEM.en.md	✅ 存在
ADVANCED_NODE_DISCOVERY.md	ADVANCED_NODE_DISCOVERY.en.md	✅ 存在
ADVANCED_DECISION_ENGINE.md	ADVANCED_DECISION_ENGINE.en.md	✅ 存在
DATA_HANDLING.md	DATA_HANDLING.en.md	✅ 存在

実装・SDK

日本語	英語	状態
EvoSpikeNet_SDK.md	EvoSpikeNet_SDK.en.md	✅ 存在
SDK_QUICKSTART.md	SDK_QUICKSTART.en.md	✅ 存在
UserManual.md	UserManual.en.md	✅ 存在

RAG・分析

日本語	英語	状態
RAG_SYSTEM_DETAILED.md	RAG_SYSTEM_DETAILED.en.md	✅ 存在
RAG_JAPANESE_PARTICLE_ISSUE.md	RAG_JAPANESE_PARTICLE_ISSUE.en.md	✅ 存在
QUERY_RESPONSE_ANALYSIS.md	QUERY_RESPONSE_ANALYSIS.en.md	✅ 存在

高度な機能

日本語	英語	状態
L5_FEATURE_BREAKDOWN.md	L5_FEATURE_BREAKDOWN.en.md	✅ 存在
L5_EVO_GENOME_IMPLEMENTATION_PLAN.md	L5_EVO_GENOME_IMPLEMENTATION_PLAN.en.md	✅ 存在
LLM_INTEGRATION_STRATEGY.md	LLM_INTEGRATION_STRATEGY.en.md	✅ 存在

その他

日本語	英語	状態
SIMULATION_RECORDING_GUIDE.md	SIMULATION_RECORDING_GUIDE.en.md	✅ 存在
P1_P2_ERROR_HANDLING_FIXES.md	P1_P2_ERROR_HANDLING_FIXES.en.md	✅ 存在
DOCUMENTATION_UPDATE_SUMMARY.md	DOCUMENTATION_UPDATE_SUMMARY.en.md	✅ 存在

📊 多言語化統計

カテゴリ	総ファイル数	英語版あり	カバレッジ
コアドキュメント	10	4	40%
概念・システム	15	10	67%
実装・SDK	20	8	40%
RAG・分析	8	6	75%
高度な機能	12	8	67%
その他	36	15	42%
合計	101	51	~50%

🎯 優先度別翻訳計画

Phase 1: 必須ドキュメント（優先度: 高）✅

• ✅ index.en.md
• ✅ overview.en.md
• ✅ getting-started/quickstart.en.md
• 🔄 features.en.md
• 🔄 faq.en.md

Phase 2: ユーザーガイド（優先度: 高）

• [ ] getting-started/installation.en.md
• [ ] getting-started/first_simulation.en.md
• [ ] guides/web_ui.en.md
• [ ] guides/training.en.md

Phase 3: リファレンス（優先度: 中）

• [ ] reference/api_reference.en.md
• [ ] reference/module_reference.en.md
• [ ] reference/configuration.en.md

Phase 4: 貢献ガイド（優先度: 中）

• [ ] contributing/guidelines.en.md
• [ ] contributing/development_setup.en.md
• [ ] contributing/coding_standards.en.md
• [ ] contributing/license.en.md
• [ ] contributing/support.en.md

Phase 5: 高度なトピック（優先度: 低）

• 既存の.en.mdファイルが多数存在
• 必要に応じて更新

🔧 言語切り替え機能

Material for MkDocsの設定

mkdocs.ymlの設定:

extra:
  alternate:
    - name: 日本語
      link: /
      lang: ja
    - name: English
      link: /en/
      lang: en

ページ内言語リンク

各ドキュメントの上部に言語切り替えリンクを追加:

日本語版:

[🇺🇸 English](index.en.md) | 🇯🇵 日本語

英語版:

🇺🇸 English | [🇯🇵 日本語](index.md)

📝 翻訳ガイドライン

用語の統一

日本語	英語
スパイキングニューラルネットワーク	Spiking Neural Network (SNN)
分散脳システム	Distributed Brain System
進化的学習	Evolutionary Learning
フェデレーテッド学習	Federated Learning
RAGシステム	RAG System
ニューロン	Neuron
シナプス	Synapse
スパイク	Spike
膜電位	Membrane Potential
発火	Firing / Spike

スタイルガイド

日本語: - です・ます調 - 技術用語は英語併記（初出時） - 例: スパイキングニューラルネットワーク（SNN）

英語: - Technical but accessible - Use active voice - Include code examples - Define acronyms on first use

🚀 新規ドキュメント作成時の手順

1. 日本語版を作成

# 新しいドキュメントを作成
vim docs/new_feature.md

2. 英語版を作成

# 英語版を作成
vim docs/new_feature.en.md

3. 相互リンクを追加

new_feature.md (日本語版):

[🇺🇸 English](index.en.md) | 🇯🇵 日本語

# 新機能のタイトル
...

new_feature.en.md (英語版):

🇺🇸 English | [🇯🇵 日本語](index.md)

# New Feature Title
...

4. mkdocs.ymlに追加

nav:
  - セクション名:
    - 日本語タイトル: new_feature.md

英語版は自動的に .en.md を認識します。

🔍 検索機能

多言語検索

mkdocs.ymlの検索設定:

plugins:
  - search:
      lang:
        - ja
        - en
      separator: '[\s\-\.]+'

特徴: - 日本語・英語両方で検索可能 - 形態素解析による日本語検索 - 英語のステミング対応

📊 現在の多言語化状況

完成度

全体の多言語化率: ~50%
├─ コアドキュメント: 40% (4/10)
├─ 概念・システム: 67% (10/15)
├─ 実装・SDK: 40% (8/20)
├─ RAG・分析: 75% (6/8)
├─ 高度な機能: 67% (8/12)
└─ その他: 42% (15/36)

新規作成（本セッション）

• ✅ docs/index.en.md - 英語版ホームページ
• ✅ docs/overview.en.md - 英語版プロジェクト概要
• ✅ docs/getting-started/quickstart.en.md - 英語版クイックスタート

🎯 次のステップ

短期目標（1週間以内）

1. features.en.md の完成
2. faq.en.md の翻訳
3. installation.en.md の作成
4. first_simulation.en.md の作成

中期目標（1ヶ月以内）

1. 全ユーザーガイドの英語化
2. API/SDKドキュメントの英語化
3. リファレンスドキュメントの英語化

長期目標（3ヶ月以内）

1. 全ドキュメントの英語版完成
2. 自動翻訳パイプラインの構築
3. 多言語ドキュメントの同期メンテナンス

🤝 貢献

翻訳への貢献

英語版ドキュメントの作成・改善への貢献を歓迎します！

手順: 1. GitHub Issuesで翻訳予定を宣言 2. 翻訳作業を実施 3. Pull Requestを作成 4. レビュー・マージ

報酬: - コントリビューターとして認定 - READMEに名前掲載 - 優先サポート（5+ PR）

📞 お問い合わせ

多言語化に関する質問・提案は:

• GitHub Discussions: 質問・議論
• Email: maoki@moonlight-tech.biz
• Issue: 翻訳リクエスト

---

最終更新: 2025年12月17日 多言語化率: ~50% (51/101 ファイル) ステータス: Phase 1 完了、Phase 2 進行中