自动代码文档生成
连接仓库并从源代码生成分层文档树，而不是从空白页面或 MDX 文件开始。
DocuWriter
认领DocuWriter 是一款 AI 代码文档工具，可直接从已连接的仓库生成代码文档、API 文档和 UML 图，帮助团队在代码变更时保持文档同步。
DocuWriter 的功能
DocuWriter 是一款 AI 代码文档工具，可连接到仓库并从源代码生成文档。该产品聚焦三类输出：代码文档、API 文档和 UML 图，目标是在不从零手工编写的情况下，将现有代码库转化为结构化文档集。
源信息描述了一种工作流：DocuWriter 使用 AST 解析和代码感知检索管道读取代码库，然后在仓库发生变化时保持文档同步。它支持 GitHub、GitLab、Bitbucket 和 Azure DevOps，并通过其 Autopilot Agent 提供可审阅的更新建议。
功能
API 文档
从 API 代码生成 Swagger/OpenAPI 风格的 API 文档，包括端点和请求模式的参考信息。
UML 图生成
从代码库创建类图、时序图和组件图，源信息中提到了 Mermaid 和 PlantUML。
Autopilot AI Agent
监控已连接的仓库变化，并在代码演进时打开可审阅的更新建议，让文档与代码保持一致。
发布与导出选项
将文档发布到私有团队空间或面向公众的网站，并导出为 Markdown、Word、PDF、Confluence 或 Git。
AI 工作区与 MCP 访问
使用空间进行文档管理，并通过 MCP 连接到 ChatGPT、Claude 或 Cursor，功能页也提到了 n8n 集成。
使用场景
继承而来的代码库
当团队几乎没有现成文档时，为大型或继承而来的代码库生成结构化的源头文档起点。
文档漂移
在频繁提交或拉取请求使手动文档难以维护时，保持参考资料的最新状态。
工程入职
帮助新工程师查找架构、API 和模块信息，而无需依赖口口相传的知识或反复在 Slack 中提问。
合规与审查工作
为审计、尽职调查或合作伙伴评审生成代码、API 和 UML 文档，以便提供有组织的技术材料。
交接与迁移
为迁移、收购、客户交付或团队间内部交接生成并导出交接包。
Pros and Cons
Pros
- 可直接从原始源代码生成文档，因此即使没有现成文档也能使用。
- 覆盖三类核心文档输出：代码文档、API 文档和 UML 图。
- 通过 Autopilot 审阅工作流，让文档与仓库变更保持同步。
- 支持多个仓库平台，包括 GitHub、GitLab、Bitbucket 和 Azure DevOps。
- 提供面向团队空间、公共网站以及 Markdown、Word、PDF、Confluence 和 Git 等常见格式的导出与发布选项。
Cons
- 定价和方案边界在提供的源信息中仅部分说明，因此购买者可能需要在定价页确认当前限制和计费细节。
- 部分集成仅以高层级方式描述，源信息并未完整说明每个受支持仓库主机的工作流挂钩或平台特定行为。
FAQ
DocuWriter 如何工作？
DocuWriter 连接到仓库，分析代码库，并从源代码生成文档产物。源描述了一个三步流程：连接你的仓库，让 DocuWriter 读取代码，然后审阅、发布并保持文档更新。
它可以生成哪些类型的文档？
源信息显示，DocuWriter 可生成代码文档、API 文档和 UML 图。功能页还描述了 Swagger/OpenAPI 输出，以及 UML 类图、时序图和组件图。
它连接哪些仓库平台？
DocuWriter 支持 GitHub、GitLab、Bitbucket 和 Azure DevOps。源信息提到支持 GitLab 自托管，并可通过 OAuth 或个人访问令牌连接。
DocuWriter 是免费的吗，还是需要付费方案？
定价页列出了付费方案，并说明价格按每次生成计费，而不是按席位计费。还提到了 Starter 方案、按年计费送四个月，以及用于 SSO、自托管运行时或自定义用量的 Custom 方案。
文档可以共享或导出吗？
源信息显示，输出可发布到私有团队空间或面向公众的网站，也可以导出为 Markdown、Word、PDF、Confluence 或 Git。还说明每个空间都会以 MCP 服务器形式发布。
Quick Facts
- 类别
- 开发者工具
- 主要用途
- AI 代码文档和 API 文档
- 支持的仓库
- GitHub、GitLab、Bitbucket、Azure DevOps
- 输出类型
- 代码文档、API 文档、UML 图
- 源站点
- docuwriter.ai
- 定价模式
- 按次生成计费的付费方案