Evidoc — 面向 agentic repositories 的文檔漂移控制
- TypeScript
- Node.js
- MCP
- GitHub Actions
- CLI
- Local Web UI
- Documentation Drift
- Agent Workflows
一個公開、本地優先的開發者工具,檢查 README、操作指南、agent 指令、範例與 API 說明是否仍與目前程式碼庫一致。它讓人工審查、CI 與編程 agent 在採信或修復過期內容前,共用同一份本地證據。
項目概覽
角色 獨立開發者 — 產品定位、CLI、MCP server、本地 Command Center、GitHub Action、Local Git Gate、release workflow
場景
AI 原生程式碼庫很容易累積過期指令:README 中的命令與 package scripts 不一致,AGENTS.md 和 CLAUDE.md 保留舊路徑,範例不再匹配 API,而編程智能體可能在檢查源碼前就採信這些說明。Evidoc 將文件可信度問題轉化為一套本地證據核驗流程。
產品策略
我把信任檢查包成一套本地工作流,覆蓋 CLI、MCP server、本地 Web UI 與 GitHub Action。每個入口都先把文檔主張對照 repo 證據,再提出修復建議或阻斷 gate。
成果與當前階段
公開發布 v0.3.2,並透過 npm 提供 @evidoc/evidoc;交付 CLI、MCP server、本地 Web UI、GitHub Action、Local Git Gate,以及核心庫、儀表板、報告和審查日誌等構件
我的工作
- CLI 工作流:檢查 drift、運行 doctor diagnostics、生成 repo-local reports,並在命令行執行 local gates
- 面向 coding agents 的 MCP server,把 drift status、scans、diagnosis、doc-fix suggestions 與明確 review logging 作為受控 tools 暴露
- 雙語 Evidoc Command Center / Local Web UI,用於 repository health、triage、repair prompts 與 local-gate visibility
- GitHub Action 支持 CI-side drift checks、PR feedback、changed-file focus,並能檢測舊 DriftGuard action references 的相容性
- v0.1.0 release 完成 DriftGuard -> Evidoc rename,覆蓋 CLI、npm packages、.evidoc state、MCP、GitHub Action、local app 與 docs
- v0.3.x 以 npm scoped package @evidoc/evidoc 發布,承接 Evidoc namespace 遷移、topological npm publication 與 0.3.2 發布加固
技術證據
- Repo-local evidence model:先對照 commands、paths、symbols、package scripts、frontmatter source bindings、API surfaces 與 changed files,再信任文檔 claims
- Agent-safe defaults:預設 read-only checks,review logs 與 repair proposals 有明確寫入邊界,且不依賴遠端項目知識
- Repair workflow 把 evidence、diagnosis 與 patch suggestions 分開,每項 generated fix 都需經審查後才成為 repository change
- Release hardening 覆蓋 doctor readiness、scoped package artifacts、GitHub Action behavior,以及與當前 scoped npx 和 local GUI paths 對齊的 docs
為什麼文檔漂移重要
Coding agents 越來越常先讀 repository instructions,再讀 source files。如果這些 instructions 過期,agent 可能會很自信地執行已不存在的 commands、paths、policies 或 examples。
Evidoc 讓文檔信任變得明確:先掃描 repo、收集 evidence、標記 stale claims,再決定修文檔、阻斷 gate,或交給人工審查。
CLI、MCP、Command Center、CI
同一套 evidence workflow 覆蓋多個入口:CLI 做本地檢查,MCP server 服務 agent workflows,Local Web UI 用於 triage,GitHub Action 用於 pull-request feedback。
v0.1.0 release 把這些入口統一到 Evidoc 名稱下,同時保留對舊 DriftGuard action references 的相容性檢測。
當前分發經由 npm scoped package @evidoc/evidoc,版本為 v0.3.2,承接 namespace 遷移與 release hardening。
可審查的修復流程
這個工具以可審查 evidence 組織修復。diagnosis、proposed fixes 與 accepted repository changes 是彼此分開、清楚可見的階段。