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 是彼此分开、清楚可见的阶段。