開発
ドキュメント索引
Fumadocsドキュメントサイト内の全ドキュメントの担当スコープ一覧。更新対象の特定に使用する開発用Index
このページは、BluePeriod Docs に含まれる全ドキュメントの 担当スコープ を一覧化した索引です。コード変更や機能追加に伴うドキュメント更新の際、影響を受けるドキュメントを特定するために使用します。
ユーザーコンテンツ
初めての方へ(getting-started/)
| ファイル | スコープ |
|---|---|
| about-documentsite | Docsサイト自体の構成説明。ユーザー向け/開発向けの2領域の区分、WikiLinks、関連リンク |
| what-is-blueperiod | BluePeriodの概要。他ツールとの違い(BYOK/BYOD/数値排除)、主な機能一覧、対応環境(Web/Desktop) |
| philosophy | 設計思想。3原則(BYOK/BYOD/Qualitative First)+ エージェント共生 + 設計哲学(静謐なアトリエ/原子操作) |
| installation | インストール手順。Web版(アクセスのみ)とDesktop版(Tauri V2、.exe/.dmg/AppImage)、比較表、ソースビルド |
| first-project | 初回プロジェクト作成のチュートリアル。5層構造の理解、Section執筆、AI壁打ち、エクスポート |
| writing-basics | 執筆画面の操作。3パネルレイアウト(プロット/エディタ/AI)、モバイルUI、パネル間連携 |
| ai-setup | AIプロバイダー設定。6プロバイダー(Gemini/OpenAI/Anthropic/OpenRouter/Ollama/LM Studio)、Chat AI/執筆AIの2系統設定、推奨構成例 |
執筆(writing/)
| ファイル | スコープ |
|---|---|
| plot-structure | 5層構造の詳細。各層の役割とメタデータ(theme/expected_word_count/story_purpose/target_word_count)、プロット操作、階層活用例 |
| manuscript-editing | 原稿カードの操作。テキスト編集、言語タブ(JA/EN/ZH)切替、Zenモード、auto-save(2秒)、フォントカスタマイズ、文字数確認 |
| ai-assistant | AIチャット機能。エージェントモード、ReActパターン、3戦略(chat_only/general_agent/writing)、アーティファクト、コンテキスト圧縮、キャラクター選択 |
| ai-generation | AIによる本文生成。生成単位(Section〜Part)、コンテキスト参照、書き換え(Rewrite)、Adit形式編集、バッチ処理 |
| ai-editorial-agent | 編集エージェントの詳細。ReActサイクル、プロット/原稿/記憶ツール一覧、実行前確認、思考ログ |
| ai-translation | 多言語翻訳。Section単位翻訳(言語タブ)、プロジェクト単位翻訳(Publish Wizard内)、翻訳指示 |
| ai-characters | AIキャラクター設定。型(name/prompt/avatarUrl)、作成手順、プロンプト書き方の例、切り替え |
| memory-system | 長期記憶。Oramaベクトル検索、パラメータ(検索結果数/類似度しきい値)、.bluememory形式、メモリ機能の有効化 |
公開(publishing/)
| ファイル | スコープ |
|---|---|
| publish-work | Publish Wizard の5ステップ(公開先→メタデータ→翻訳→査読→公開)、公開ステータス3種(Published/Unlisted/Draft)、公開後の管理 |
| explore | 作品発見機能。検索、タグフィルタリング、作品カード、ライブラリ(ブックマーク)、公開プロフィール |
| reader | リーダー。階層的レンダリング(Part→Story)、目次ドロワー、読書進捗の自動保存(IntersectionObserver)、プレビュー |
データと同期(data-and-sync/)
| ファイル | スコープ |
|---|---|
| import-export | データ移出入。3形式の比較(.blueproject=プロジェクト単体/.blueperiod=IndexedDB全体/.bluememory=記憶のみ)、各形式の上書き/追加動作、移行手順 |
| cloud-sync | クラウド同期(Pro機能)。Zero-Knowledge暗号化(Web Crypto API + Supabase Storage)、Sync Key管理、Simple Full Sync(手動同期のみ)、HITL確認ダイアログ |
| database-management | ローカルデータベース。Local-First設計の制約(Web版のドメイン依存・オフライン未対応、Desktop版の独立性)、管理画面4タブ(長期記憶/メンテナンス/モデルキャッシュ/システムDB)、auto-save連携、ブラウザ注意点 |
| desktop-app | Desktop版固有機能。ローカルLLM(Ollama/LM Studio)、MCP sidecar(STDIO→Hono Broker→WebView Bridge)、HITL、ネイティブ機能(トレイ/通知/自動更新)、Web版との比較 |
MCP(mcp/)
| ファイル | スコープ |
|---|---|
| overview | MCP概要。Shallow/Deep MCPの違い、WebView Bridge Patternの3層(STDIO→Hono Broker→WebView Bridge)、HITL確認フロー、三層整合性 |
| setup | MCP接続設定。Claude Code/Cursor向けmcp.json設定例、ポート3703、トラブルシューティング。現在は開発者(ソースコードあり)向けの手順のみ記載 |
| tool-reference | ツール一覧。40+ツールを6カテゴリに分類(プロジェクト/プロット/原稿/キャラクター/プロンプト/アーティファクト/ユーティリティ/システム)、projectIdバインディング |
| adit-editing | 構造化編集。JSONパッチ形式(original_snippet/new_snippet)と区切り文字形式(<<<<<<< SEARCH / ======= / >>>>>>> REPLACE)の2形式、使い分け比較 |
| examples | 実践例5本。プロジェクト確認、原稿確認とAdit修正、プロット再構築、新規セクション追加と生成、アーティファクト壁打ち。コンテキスト節約とAdit活用のコツ |
開発ドキュメント(system/)
メタドキュメント
| ファイル | スコープ |
|---|---|
| document_architecturex | ドキュメント体系の構造定義。セクション2がFumadocs移行後の構造(WikiLinks二段構え方式、命名規則)を記述 |
| document_maintenancex | ドキュメント整備のワークフロー。Issue→Plan→ReportのDDD手順、更新すべきファイルの判断基準 |
| document_index | 本ファイル。全ドキュメントの担当スコープ索引 |
プロジェクト定義
| ファイル | スコープ |
|---|---|
| 00_philosophies_of_blueperiod | プロジェクト哲学。3原則(BYOK/BYOD/Qualitative First)、エージェント共生(Deep MCP/Gapless Dev)、設計哲学(静謐なアトリエ/原子操作) |
| 00_about_project_BluePeriod | プロジェクト概要 |
| 01_architecture | 全体アーキテクチャ。システム構成、データフロー |
| 02_technology_stack | 技術スタック一覧と選定理由 |
設計・仕様
| ファイル | スコープ |
|---|---|
| 03_state_management | 状態管理(Jotai)。Atom定義、グローバルステート設計 |
| 04_database_schema | ローカルDBスキーマ(IndexedDB/Dexie.js)。テーブル定義 |
| 04_database_schema_supabase | Supabase DBスキーマ。サーバー側テーブル定義 |
| 05_api_specification | API仕様。エンドポイント定義 |
| 05_migration_guide | マイグレーションガイド。DB移行手順 |
| 06_development_guidelines | 開発ガイドライン。コーディング規約、ブランチ戦略 |
| 07_locale_system | 国際化(i18n)。ロケール管理方式 |
| 08_git_commit_conventions | Gitコミット規約。コミットメッセージフォーマット |
| 09_design_system | デザインシステム。セマンティックトークン、カラーパレット、タイポグラフィ |
| 09_sync_components | 同期UIコンポーネント設計。実装仕様、Jotai Atom連携、コード例 |
データ・同期
| ファイル | スコープ |
|---|---|
| 10_memory_portability_standard | 記憶ポータビリティ規格。.bluememory形式の仕様 |
| 10_sync_architecture | 同期アーキテクチャ。Simple Full Sync、E2E暗号化方式 |
| 11_long_term_memory_architecture | 長期記憶アーキテクチャ。OramaベクトルDB、埋め込みモデル |
AI・エージェント
| ファイル | スコープ |
|---|---|
| 12_ai_agent_architecture | AIエージェントアーキテクチャ。ReActパターン、戦略ルーティング |
| 13_hybrid_architecture | ハイブリッドアーキテクチャ。ローカル/クラウドAIの使い分け |
| 14_ai_provider_integration_guide | AIプロバイダー統合ガイド。各プロバイダーの接続・設定方法 |
| 18_agent_tool_integration_guide | エージェントツール統合ガイド。ツール定義・登録方法 |
| 19_mcp_architecture | MCPアーキテクチャ。WebView Bridge Pattern、STDIOサーバー、Hono Broker |
| 20_ai_agent_tool_architecture_overview | AIエージェントツール全体アーキテクチャ。全ツールの分類と関係 |
| MCP_GUIDE | MCP利用ガイド。設定手順・使用例 |
インフラ・決済
| ファイル | スコープ |
|---|---|
| 15_stripe_architecture | Stripe決済アーキテクチャ。Checkout/Webhook/サブスクリプション管理 |
| 15_stripe_integration_guide | Stripe統合ガイド。実装手順 |
| 16_backend_architecture | バックエンドアーキテクチャ。Supabase/Edge Functions |
| 17_tauri_development_guide | Tauri Desktop版開発ガイド。sidecar、システムトレイ、自動更新 |
| 36_testing_strategy | テスト戦略。テスト方針・カバレッジ目標 |
コンポーネント(components/)
| ファイル | スコープ |
|---|---|
| 00_component_index | コンポーネント全体索引 |
| 01_ai_chat_components | AIチャット関連コンポーネント |
| 02_editor_components | エディタ関連コンポーネント |
| 03_project_management | プロジェクト管理コンポーネント |
| 04_library_components | ライブラリ(ブックマーク)コンポーネント |
| 05_explore_components | Explore(作品発見)コンポーネント |
| 06_details_page_components | 詳細ページコンポーネント |
| 07_reader_viewer_components | リーダー/ビューアーコンポーネント |
| 08_navigation_components | ナビゲーションコンポーネント |
| 09_sync_components_ui | 同期コンポーネントのUI設計。データフロー図、エラーハンドリング、セキュリティ考慮 |
| 10_settings_components | 設定画面コンポーネント |
| 11_user_profile_components | ユーザープロフィールコンポーネント |
| 12_home_components | ホーム画面コンポーネント |
| 13_publish_components | 公開フロー(Publish Wizard)コンポーネント |
| 14_common_components | 共通コンポーネント |
Agent Skills(agent_skills/)
| ファイル | スコープ |
|---|---|
| mcp_blueperiod_writing_skill | BluePeriod執筆用MCPスキル定義 |
トラブルシューティング(troubleshooting/)
| ファイル | スコープ |
|---|---|
| README | トラブルシューティングセクションの概要・インデックス |
| 01_firefox_sync_issue | Firefoxでの同期問題 |
| monorepo-bun-workspaces | Bun Workspaces(monorepo)関連の問題と解決 |
| nextjs-15-async-params | Next.js 15の非同期params対応 |
| nextjs-caching | Next.jsキャッシュ関連の問題 |
| react-state-management | React状態管理のベストプラクティス |
| supabase-type-encoding-issue | Supabase型エンコーディング問題 |
| 2025-11-05_thinking_manual_for_solving_complex_problems | 複雑な問題解決の思考マニュアル |
| 2025-11-08-autosave-best-practice | Auto-saveのベストプラクティス |
| 2025-11-10_layout-architecture-guide | レイアウトアーキテクチャガイド |
| api-connector-testing-guide | APIコネクタテストガイド |
| safe_file_editing_guidelines_for_Antigravity | 安全なファイル編集ガイドライン(Antigravity向け) |
更新時の参照方法
コード変更に伴うドキュメント更新が必要な場合:
- 変更内容が影響する 機能領域 を特定する
- 上記の表から、該当スコープを持つドキュメントを洗い出す
- 該当ドキュメントの本文を読み、更新が必要か判断する
- 更新が必要な場合は、document_maintenance のワークフローに従って更新する
例:新しいAIプロバイダーを追加した場合
- ai-setup(対応プロバイダー一覧の更新)
- 14_ai_provider_integration_guide(統合ガイドの追加)
- tool-reference(ツールへの影響確認)