docs — プロジェクトドキュメント
TelosDB の仕様・設計・参照資料を格納するディレクトリです。
構成
| ディレクトリ |
内容 |
| specification/ |
システム仕様・設計。アーキテクチャ、DB、MCP API、UI、開発ガイド、埋め込み・エディション、モノリシック化、KPI・検証、UI テスト、OpenAPI / MCP スキーマ。 |
| plans/ |
今後の実装計画。機能単位でファイルまたはサブフォルダを置く。 |
| issues/ |
Issue 同期用の Markdown(Git 追跡外。node tools/scripts/sync_issues.mjs で同期)。 |
| references/ |
調査メモ・外部資料の参照。ベクトル化手法、BM25、Elasticsearch 等。 |
主なファイル(specification/)
01〜06: 製品仕様の本体(概要・アーキテクチャ・DB・MCP・開発・UI)。07〜12: 補足(埋め込み技術・ゴール/KPI・検証手順・モノリシック経緯・Pro 動作確認・UI テスト方針)。
- 01_system_overview.md — システム概要・エディション・主要機能
- 02_architecture_design.md — アーキテクチャ設計
- 03_database_specification.md — データベース仕様
- 04_mcp_api_specification.md — MCP API 仕様
- 05_development_guide.md — 開発ガイド(ビルド・拡張)
- 06_ui_design_spec.md — UI デザイン仕様
- 07_embedding_tract.md — 埋め込みモデル(ONNX + tract)の組み込み
- 08_embedding_tract_goals_and_kpi.md — 埋め込み改修:ゴールとテスト KPI
- 09_embedding_tract_implementation_and_tests.md — KPI 達成のための改修・テスト
- 10_monolithic_dev.md — モノリシック化(開発時アーキテクチャ)
- 11_pro_vectorization_and_ann.md — Pro ベクトル化・ANN 動作確認
- 12_ui_testing_options.md — UI をテストに組み込む方法(E2E / Playwright 等)
- 13_autostart.md — 自動起動仕様(ログイン時起動・設定連携・UI・テスト)
- 14_folder_monitor.md — フォルダ監視仕様(notify・DB 連携・設定 UI)
- mcp.json, openapi.yaml — MCP / API スキーマ
plans/ は計画ごとにファイルまたはサブフォルダを置く。
- plans/cross_platform.md — クロスプラットフォーム検証(autostart・folder_monitor の macOS / Linux 動作確認・アンインストール時のエントリ残留)
- plans/folder_monitor_enhancements.md — フォルダ監視の拡張(PollWatcher フォールバック・初期スキャン改善・権限エラー UI・パス正規化)
- plans/lda/ — LDA(潜在的ディリクレ配分)の扱い。検討事項別に分割(スコープ・技術・UI 改造・実装ステップ・注意事項・参照)。
運用ルール(Issue 管理・Git 運用など)は .agent/rules/ にあります。