TelosDB / docs /
@楽曲作りまくりおじさん 楽曲作りまくりおじさん authored 1 day ago
..
plans v0.3.2: 取得件数既定5件、フッターv?・バージョン一致テスト、E2E統合・配布前ルール、ジャーナル014 1 day ago
specification v0.3.2: 取得件数既定5件、フッターv?・バージョン一致テスト、E2E統合・配布前ルール、ジャーナル014 1 day ago
README.md リファクタリング実施・仕様反映・計画削除(ジャーナル 202603-012) 1 day ago
README.md

docs — プロジェクトドキュメント

TelosDB の仕様・設計・参照資料を格納するディレクトリです。

構成

ディレクトリ 内容
specification/ システム仕様・設計。アーキテクチャ、DB、MCP API、UI、開発ガイド、埋め込み・エディション、モノリシック化、KPI・検証、UI テスト、OpenAPI / MCP スキーマ。
plans/ 今後の実装計画。計画ごとにサブフォルダを切る(例: plans/folder_monitor/)。
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 等)
  • mcp.json, openapi.yaml — MCP / API スキーマ

plans/ は計画ごとにサブフォルダを置く。

  • plans/auto_start/ — ユーザーログイン時に自動起動する仕組み。検討事項別に分割(スコープ・技術方針・UI 改造・実装ステップ・注意事項・参照)。
  • plans/folder_monitor/ — 指定フォルダ監視(追加・削除・更新の検出→DB取り込み・ベクトル化)
    • folder_monitor.md — 計画トップ(目的・目次)
    • folder_monitor_01_scope.md — 01 スコープ
    • folder_monitor_02_tech.md — 02 技術方針(notify・デバウンス・ネットワーク・Config 等)
    • folder_monitor_03_os_protocol.md — 03 OS・ファイルプロトコル別実装方針
    • folder_monitor_04_phases.md — 04 実装ステップ(Phase 1〜5)
    • folder_monitor_05_considerations.md — 05 注意事項・未決定
    • folder_monitor_06_references.md — 06 参照・調査元
  • plans/lda/ — LDA(潜在的ディリクレ配分)の扱い。v0.3.3 Community 版で実装。LSA と LDA を切り替え、規定 128 次元・ユーザー指定で再構成。検討事項別に分割(スコープ・技術・UI 改造・実装ステップ・注意事項・参照)。

運用ルール(Issue 管理・Git 運用など)は .agent/rules/ にあります。