Skip to content

Documentation use case

技术文档与知识库维护

把产品结构、术语表、代码示例规范、版本说明和发布文档放到同一个项目里。AI 可以更新段落、补全说明和统一术语,所有写入先走 Diff 审阅。

API 文档术语一致版本说明代码示例Markdown 导出

适合谁

产品文档维护者

需要长期维护概览、快速开始、API、FAQ 和版本说明。

开发者关系团队

需要把示例、教程和发布材料保持同一口径。

开源项目维护者

希望把 README、指南和变更说明按 Markdown 结构维护。

内部知识库负责人

需要让 AI 帮忙整理,但不希望它绕过审阅直接改文档。

工作流

01镜像产品结构

按概念、安装、API、示例、FAQ 和发布说明拆分文件。

02写入规范

把术语表、代码风格、受众层级和禁用表达写进 @system。

03引用资料

用 @ 文件、@web 或 URL 转 Markdown 把资料带进上下文。

04审阅改动

检查 AI 对步骤、参数、示例和警告语的每一处修改。

05导出交付

导出 Markdown 包进入 Git 流程,或生成 Web 包供评审。

All Writer 技术文档 Diff 审阅界面截图

先维护一页快速开始

从一个快速开始页面试起:让 AI 补全步骤,再用 Diff 审查是否符合产品真实行为。