AIGNE DocSmith：代码即文档
轻松打造完美文档，无需亲力亲为。
在软件开发中，代码是构建的框架，文档则是设计蓝图。但现实往往是，蓝图逐渐过时，而框架却不断演变。如果文档能够与代码保持同步更新，并拥有同样的智慧，那会是怎样一番景象？
AIGNE DocSmith 并非只是另一个代码编写工具，而是让项目与其开发者保持持续沟通的全新方式。您可以将其视为与代码库同步的文书：它倾听代码的“声音”，提出文档概要，撰写项目故事，并随着项目的演进不断更新。
挑战：隐性知识的回声
我们都明白这种矛盾的处境：文档对团队协作至关重要，却往往最容易被忽略和过时。知识深藏于开发者脑海中和代码库的细枝末节里，而非清晰地呈现在 README 文件中。文档的滞后会拖慢团队进度，掩盖代码的真正意图，还会增加新成员的上手成本。现在，无需亲自动手，即可创建优质文档。（毕竟，AI 代理从不抱怨截止日期，😉）
DocSmith 的理念
基于 ArcBlock 的 AIGNE Famework，DocSmith 是一款 AI 驱动的智能代理，可直接从源码自动生成详细、结构化和多语言文档。它以代码仓库作为唯一事实来源。利用智能代理进行文档的规划、撰写和更新，确保代码变更时文档也同步更新。同时，人工审核文档结构和编辑内容，使文档与构建版本同步发布，而非滞后数周。
- 规划：将代码库梳理成清晰易懂、可供浏览的提纲。
- 草案：生成准确且易于理解的页面（如有需要，可包含图表）。
- 更新：根据针对性的反馈重新生成特定章节，而不是重写整个文档。
- 翻译：以多种语言发布内容，让不熟悉你默认语言的受众也能理解。
- 发布：将最新版本发布到 DocSmith 门户或您的自有网站，供用户访问。
ArcBlock 团队在内部所有项目中使用 DocSmith 来确保文档保持最新。
AIGNE生态系统：构建未来的一块拼图
DocSmith 是 AIGNE 生态系统中的 Smiths 之一。如果说 DocSmith 如同一位记录项目故事的史官，那么 WebSmith 便是将代理转换为网站的架构师，而 CodeSmith 则是负责审查和改进代码的工匠。它们基于相同的 AIGNE 框架、AIGNE CLI 和 AIGNE Hub，因此您既可以选择单独使用其中一个工具，也可以直接采用全套工具，而无需改变您的工作流程。
快速开始
// Install the AIGNE CLI
npm i -g @aigne/cli
// Generate docs from your repo
aigne doc generate
// Update a specific page with feedback
aigne doc update --docs overview.md --feedback "Add API examples and troubleshooting tips"
// Translate and publish
aigne doc translate --langs zh --docs overview.md
aigne doc publish # choose hosted portal or self‑hosted前行之路
DocSmith 的发布标志着一个新的开端。我们的路线图着重于强化其智能化程度，并将其更深度地融入到开发生命周期中，从而让企业轻松获取文档。
- 直接 CI/CD 集成：将文档直接纳入 CI/CD 流程。
- 文档质量评估：我们引入了一系列指标和报告机制，用以衡量文档的清晰度和有效性。
- 用户体验提升：开发更便捷易用的信息排版和呈现组件。
我们不只是在打造一款工具，更是在制定软件理解和维护的新标准。
了解架构
诚邀您体验 AIGNE DocSmith。了解其工作原理，在您的项目中试用，并为其发展贡献力量。与其空谈蓝图和拼图，不如现在就动手体验。
立即免费试用 AIGNE DocSmith，免费发布文档，或将其自托管至您的服务器。