How to 保持文档最新 with Eigent

工作原理

1. 分享需要记录的已变更源文件、分支、PR 或 commit。
2. 请 Eigent 搜索现有文档，查找受影响的功能名称、配置键、命令和示例。
3. 只更新需要变更的文档——保留页面结构、术语、交叉链接和 frontmatter。
4. 运行格式化和文档检查，然后让 Eigent 总结每一条面向用户的说法背后的证据。
5. 在发布前审阅摘要，确认没有内部或未发布的上下文泄露到公开文档中。

试试更多提示

• 这次 PR 中哪些现有文档页面引用了已变更的行为？
• 这次变更是否影响任何需要更新的公共 API 参数、默认值或 CLI 标志？
• 按照我们现有的格式，为这次发布撰写一条变更日志。
• 识别更新后文档中任何你无法仅凭源代码验证的面向用户的说法。

如何使用

从你需要记录的变更开始——分享分支、PR 或 commit。请 Eigent 在起草任何内容之前先搜索现有文档，这样它会更新正确的页面，而不是编写重复现有内容的新页面。保持范围尽量狭窄：一条精确的说明或示例更新比整页重写更好。为了让这个流程可重复，可以将其保存为一个技能，或让 Eigent 在每次发布后按计划运行。

预期输出

仅覆盖面向用户变更的已更新文档文件，以及变更和验证内容的摘要，外加一份无法从可信来源确认、需要人工审核的说法清单。

局限性

• 除非你明确提供，否则 Eigent 无法访问私有客户数据、未发布的路线图项目或内部 wiki。
• 文档准确性取决于源代码注释和测试覆盖率的质量——未文档化的行为可能会被遗漏。
• 对于非常大的文档站点，最好将搜索范围限定在特定章节或功能区域，而不是整个站点。