FluentDocs：在代码演进时保持文档准确
Source: Dev.to
Introduction
FluentDocs 是一个文档维护系统，能够在代码变更时保持文档的准确性。它的价值不在于编写新文档，而在于消除保持文档最新的隐性成本。FluentDocs 不再依赖记忆、手动审计或延迟的 CI 警告，而是持续将代码更改与受影响的文档关联起来。
每次 git push 时，FluentDocs 会识别哪些文档部分受到影响，解释为何受影响，并提出精确到章节级别的更新建议。作者和开发者可以在所见即所得编辑器中审阅、编辑或拒绝这些建议，然后将结果作为标准的 Pull Request 提交。
Live Demo
Background
FluentDocs 是对名为 AutoDoc 的 AI Agent 的升级版，AutoDoc 曾赢得首届 Dev.to 挑战赛。看到它的实际价值和潜力后，它被打造为完整的产品。目标是帮助开发者和技术写作者在代码演进的过程中保持文档的准确性，而不会在工作流中增加更多手动工作。
构建 FluentDocs 也体现了一个更广泛的愿景——从副业项目转向创建业务，并通过解决真实问题来探索创业之路。
Tech Stack
- Frontend & Backend: Next.js
- Editor: Tiptap (WYSIWYG) with a custom Markdown/Diff plugin
- AI Agent: FastAPI
- Authentication: NextAuth.js with GitHub provider
- Database & Search: MongoDB Atlas with Vector Search for semantic documentation mapping
- Infrastructure & Tooling:
- GitHub API: Octokit for repository interaction and PR creation
- Real‑time Updates: Server‑Sent Events (SSE)
Key Differentiators
Event‑Driven Automation
不同于需要手动提示的 AI 助手（例如 Copilot），FluentDocs 会在每次 git push 时自动触发，主动识别“文档漂移”，防止其演变为技术债务。
Semantic Context Mapping
使用向量嵌入和搜索来理解代码逻辑与文档块之间的关系，确保建议在语义上相关，而不仅仅是基于关键词。
Specialized WYSIWYG Diffing
基于自定义 Tiptap 编辑器提供可视化界面审阅 AI 建议，用户可以看到富文本差异并接受更改，而无需手动编辑原始 Markdown 文件。
Cross‑Repository Intelligence
支持文档与源代码存放在不同仓库的复杂架构，保持分布式系统之间的同步。
Seamless PR Integration
从 webhook 接收、自动创建 Pull Request（通过 Octokit）到完整的生命周期编排，直接融入现有 CI/CD 流程，无需开发者更改工具。
Submission Context
此提交作品是为 Mux 主办的 DEV 全球 Show Tell 挑战赛而准备的。