BluePeriod Docs
開発

ドキュメント索引

Fumadocsドキュメントサイト内の全ドキュメントの担当スコープ一覧。更新対象の特定に使用する開発用Index

このページは、BluePeriod Docs に含まれる全ドキュメントの 担当スコープ を一覧化した索引です。コード変更や機能追加に伴うドキュメント更新の際、影響を受けるドキュメントを特定するために使用します。


ユーザーコンテンツ

初めての方へ(getting-started/)

ファイルスコープ
about-documentsiteDocsサイト自体の構成説明。ユーザー向け/開発向けの2領域の区分、WikiLinks、URL構造(ルート直下)、検索(Orama日本語対応)、関連リンク
what-is-blueperiodBluePeriodの概要。3S(Serenity/Symbiosis/Serendipity)、主な機能一覧、対応環境(Web/Desktop)
philosophy設計思想。3S(Serenity/Symbiosis/Serendipity)の Pattern A(叙情)による説明。詳細は 00_philosophies_of_blueperiod00_verbal_identity を参照
installationインストール手順。Web版(アクセスのみ)とDesktop版(Tauri V2、.exe/.dmg/AppImage)、比較表、ソースビルド
first-project初回プロジェクト作成のチュートリアル。5層構造の理解、Section執筆、AI壁打ち、エクスポート
writing-basics執筆画面の操作。3パネルレイアウト(プロット/エディタ/AI)、モバイルUI、パネル間連携
ai-setupAIプロバイダー設定。6プロバイダー(Gemini/OpenAI/Anthropic/OpenRouter/Ollama/LM Studio)、Chat AI/執筆AIの2系統設定、推奨構成例

執筆(writing/)

ファイルスコープ
plot-structure5層構造の詳細。各層の役割とメタデータ(theme/expected_word_count/story_purpose/target_word_count)、プロット操作、階層活用例
manuscript-editing原稿カードの操作。テキスト編集、言語タブ(JA/EN/ZH)切替、Zenモード、auto-save(2秒)、フォントカスタマイズ、文字数確認
ai-assistantAIチャット機能。エージェントモード、ReActパターン、3戦略(chat_only/general_agent/writing)、アーティファクト、コンテキスト圧縮、キャラクター選択
ai-generationAIによる本文生成。生成単位(Section〜Part)、コンテキスト参照、書き換え(Rewrite)、Adit形式編集、バッチ処理
ai-editorial-agent編集エージェントの詳細。ReActサイクル、プロット/原稿/記憶ツール一覧、実行前確認、思考ログ
ai-translation多言語翻訳。Section単位翻訳(言語タブ)、プロジェクト単位翻訳(Publish Wizard内)、翻訳指示
ai-charactersAIキャラクター設定。型(name/prompt/avatarUrl)、作成手順、プロンプト書き方の例、切り替え
memory-system長期記憶。Oramaベクトル検索、パラメータ(検索結果数/類似度しきい値)、.bluememory形式、メモリ機能の有効化

公開(publishing/)

ファイルスコープ
publish-workPublish Wizard の4タブ方式(Metadata/Localization/Quality/Final)、タブステータス(✅/⚠)、認証ガード、公開ステータス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-appDesktop版固有機能。ローカルLLM(Ollama/LM Studio)、MCP sidecar(STDIO→Hono Broker→WebView Bridge)、HITL、ネイティブ機能(トレイ/通知/自動更新)、Web版との比較

MCP(mcp/)

ファイルスコープ
overviewMCP概要。Shallow/Deep MCPの違い、WebView Bridge Patternの3層(STDIO→Hono Broker→WebView Bridge)、HITL確認フロー、三層整合性
setupMCP接続設定。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_architectureドキュメント体系の構造定義。WikiLinks二段構え方式、命名規則、URL構造(ルーティング)
document_maintenanceドキュメント整備のワークフロー。Issue→Plan→ReportのDDD手順、document_indexを用いた影響分析、更新すべきファイルの判断基準
document_index本ファイル。全ドキュメントの担当スコープ索引

プロジェクト定義

ファイルスコープ
00_verbal_identityブランド定義。タグライン、ブランドステートメント、パーパス、3S、禁止用語集
00_philosophies_of_blueperiod設計思想。3S(Serenity/Symbiosis/Serendipity)、クラウンシャイネスの比喩
00_project_overviewプロジェクト技術概要。機能一覧、技術スタック、開発規約
01_architecture全体アーキテクチャ。システム構成、データフロー
02_technology_stack技術スタック一覧と選定理由
development-setup開発環境セットアップ。前提条件(Bun/Supabase/APIキー/Rust)、インストール手順、Supabase設定(Local/Remote)、環境変数、開発サーバー起動、デスクトップアプリ開発、Rust/Cargo開発、品質チェック
deploymentデプロイガイド。モノレポ構成のVercel手動デプロイ方針、各サブプロジェクト(next-app/astro/fumadocs)の手順、CI/CDリリースビルド(Tauri)、必要なRepository Secrets

設計・仕様

ファイルスコープ
03_state_management状態管理(Jotai)。Atom定義、グローバルステート設計
04_database_schemaローカルDBスキーマ(IndexedDB/Dexie.js)。テーブル定義
04_database_schema_supabaseSupabase DBスキーマ。サーバー側テーブル定義
05_api_specificationAPI仕様。エンドポイント定義(内部API /api/*、RESTful API /v1/*
21_rest_api_referenceRESTful API リファレンス。公開APIの概要・認証・エンドポイント仕様
05_migration_guideマイグレーションガイド。DB移行手順
06_development_guidelines開発ガイドライン。コーディング規約、ブランチ戦略
development_contributingコントリビューションガイド。アーキテクチャ概要、コーディング規約(命名規則)、ブランチ戦略、コミット規約、貢献フロー(小/大規模)、DDD推奨、レビュー体制、並列開発
document_driven_developmentDocument Driven Developmentの概要。AI時代の国語重視哲学、Issue→Plan→実装→Reportサイクル、ドキュメントテンプレート、AIセッションプロンプト(開発用/軽量/ADR/PR Review)
pr-review-guidePRレビューガイド。メンテナー向けレビュー観点、セキュリティチェックリスト、CI判定基準、path-based条件付き実行
07_locale_systemロケール管理方式。BCP 47言語タグの仕様と管理
07_i18n国際化(i18n)システム。i18nextとi18next-cliによる自動化ワークフロー
08_git_commit_conventionsGitコミット規約。コミットメッセージフォーマット
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_architectureAIエージェントアーキテクチャ。ReActパターン、戦略ルーティング
13_hybrid_architectureハイブリッドアーキテクチャ。ローカル/クラウドAIの使い分け
14_ai_provider_integration_guideAIプロバイダー統合ガイド。各プロバイダーの接続・設定方法
18_agent_tool_integration_guideエージェントツール統合ガイド。ツール定義・登録方法
19_mcp_architectureMCPアーキテクチャ。WebView Bridge Pattern、STDIOサーバー、Hono Broker
20_ai_agent_tool_architecture_overviewAIエージェントツール全体アーキテクチャ。全ツールの分類と関係
MCP_GUIDEMCP利用ガイド。設定手順・使用例

オンライン機能

ファイルスコープ
22_publish_systemPublishシステム。ウィザードUI(4タブ)、Jotai状態管理、localizations JSONB、AI品質レビュー、Supabase Storage/DB保存フロー
23_explore_systemExploreシステム。作品検索・フィルタ(RPC関数)、ExpandableGrid、多言語フォールバックチェーン、Library/My Works管理
24_reader_systemReaderシステム。5層構造レンダリング、多言語マニュスクリプト切替、目次ドロワー、読書進捗、MarkdownRenderer

インフラ・決済

ファイルスコープ
15_stripe_architectureStripe決済アーキテクチャ。Checkout/Webhook/サブスクリプション管理
15_stripe_integration_guideStripe統合ガイド。実装手順
16_backend_architectureバックエンドアーキテクチャ。Supabase/Edge Functions
17_tauri_development_guideTauri Desktop版開発ガイド。sidecar、システムトレイ、自動更新
36_testing_strategyテスト戦略。テスト方針・カバレッジ目標

コンポーネント(components/)

ファイルスコープ
00_component_indexコンポーネント全体索引
01_ai_chat_componentsAIチャット関連コンポーネント
02_editor_componentsエディタ関連コンポーネント
03_project_managementプロジェクト管理コンポーネント
04_library_componentsライブラリ(ブックマーク)コンポーネント
05_explore_componentsExplore(作品発見)コンポーネント
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)タブコンポーネント、AiSettingsSheet、CoverImageService、画像処理ユーティリティ
14_common_components共通コンポーネント

Agent Skills(agent_skills/)

ファイルスコープ
mcp_blueperiod_writing_skillBluePeriod執筆用MCPスキル定義

トラブルシューティング(troubleshooting/)

ファイルスコープ
READMEトラブルシューティングセクションの概要・インデックス
01_firefox_sync_issueFirefoxでの同期問題
monorepo-bun-workspacesBun Workspaces(monorepo)関連の問題と解決
nextjs-15-async-paramsNext.js 15の非同期params対応
nextjs-cachingNext.jsキャッシュ関連の問題
react-state-managementReact状態管理のベストプラクティス
supabase-type-encoding-issueSupabase型エンコーディング問題
2025-11-05_thinking_manual_for_solving_complex_problems複雑な問題解決の思考マニュアル
2025-11-08-autosave-best-practiceAuto-saveのベストプラクティス
2025-11-10_layout-architecture-guideレイアウトアーキテクチャガイド
api-connector-testing-guideAPIコネクタテストガイド
safe_file_editing_guidelines_for_Antigravity安全なファイル編集ガイドライン(Antigravity向け)

更新時の参照方法

コード変更に伴うドキュメント更新が必要な場合:

  1. 変更内容が影響する 機能領域 を特定する
  2. 上記の表から、該当スコープを持つドキュメントを洗い出す
  3. 該当ドキュメントの本文を読み、更新が必要か判断する
  4. 更新が必要な場合は、document_maintenance のワークフローに従って更新する

例:新しいAIプロバイダーを追加した場合

On this page