我们宣布推出 AIGNE DocSmith 0.9.0,这是我们迄今规模最大的一次测试版发布。此版本着力于新增多项功能与优化,旨在让文档的创建和维护变得更简单、更快速、更具成本效益。诚邀您分享宝贵反馈,共同塑造 DocSmith 的未来。

最新动态#
API 文档,化繁为简#
现在,您只需将 OpenAPI 规范 URL 添加至配置,并运行 aigne doc generate,即可直接从 OpenAPI 规范生成完整的 API 文档,其中涵盖端点、参数、示例等丰富内容。
sourcePaths:
- https://api.example.com/openapi.json这节省了数小时的手动编写 API 文档的工作。
控制推理成本#
全新的推理控制功能,助您在生成质量、运行成本与速度之间取得平衡。将其设为低,可快速完成草稿,实现速度与成本效益;而设为高,则适用于生产级文档,旨在提供更高质量,但会消耗更多 Token。
thinking:
effort: low # minimal, low, medium, high
在进行快速迭代时,可选择“低”设置;而在发布供团队信赖的正式文档时,则应选择“高”设置。
图表控制#
过多的图表可能导致文档内容冗杂。现在,您可以按 0-10 的刻度,精确设定图表的数量,其中0表示不使用任何图表,而10则代表最全面的视觉化说明。
diagramming:
effort: 5 # 0-10 scale, 0 = no diagrams, 10 = maximum清理工作区#
新增的 aigne doc clear 命令可让您选择性地移除不再需要的文档,方便重新生成。
文档评估报告#
运行 aigne doc evaluate 后,质量报告现已自动在您的浏览器中打开,从而实现更快的反馈,并加速改进。
更好地理解AI#
AFS 整合#
借助全新的 AFS,AI 代理现在能够更深入地理解您的代码库。这意味着:
- 您的文档中更准确的代码示例
- 大型、超大型项目更强的上下文感知力
- 提升大型项目/复杂代码库的文档质量
更智能的媒体处理#
AI 现可分析并描述您文档中的图像。只需将图像放置于源路径中,AI 即可为其自动生成有意义的描述。
sourcePaths:
- ./assets/images/**/*.{png,jpg}问题修复#
本次发布包含逾 40 项修复,涵盖文档生成、翻译、发布和文件操作。主要更新包括:
- 翻译功能现已能正确处理所有更新操作。
- 代码块在翻译过程中保持不变
- 已发布文档图片显示正常
- 优化嵌套 Git 仓库的路径处理
- 优化发布认证流程
增强的发布体验#
发布现已更为顺畅,得益于:
- 精简易分享的认证 URL
- 改进了出错时的错误提示
- 自动会话验证
- 改进的令牌刷新机制
您可以在发布时选择更新站点配置(Logo、名称、描述):
aigne doc publish --with-branding入门#
新用户#
npm install -g @aigne/cli@latest
aigne doc init
aigne doc create现有用户#
更新至最新版本:
npm install -g @aigne/cli@latest
aigne doc upgrade在您的 aigne.yml 文件中,可新增以下可选配置字段:
thinking:
effort: low
diagramming:
effort: 5无破坏性更改——所有现有配置均可照常工作。
深度解析#
更好的提示词#
增强的提示可生成结构更优、更具表现力的文档。我们已规范了XML标签的使用并改进了格式指南。
代币优化#
多项改进降低了 token 使用量:
- 用于定向更新的意图分析
- 大型代码库的分块处理
- 智能上下文共享
- 只选择性地再生已更改内容
展望未来#
我们正在进行:
- 生成文档高级搜索
- 自定义组件模板
- 集成更多文档平台
- 增强多语言支持
资源#
- 文档: https://docsmith.aigne.io/docs/
- GitHub: https://github.com/AIGNE-io/aigne-doc-smith
- 问题: https://github.com/AIGNE-io/aigne-doc-smith/issues
- 社区: https://community.arcblock.io/discussions/boards/aigne
共塑 v1.0#
我们正处于公测阶段,并积极完善DocSmith。我们正根据您的反馈不断优化此产品。无论您是发现了任何 Bug、有新的功能设想,抑或是了解有哪个社区亟需文档支持,都请务必在社区分享您的宝贵建议,助力我们共同打造您理想的文档工具。
即刻体验#
AIGNE DocSmith 0.9.0 让文档生成更智能、更具成本效益。无论您是为API、代码库还是整个项目编写文档,此版本都提供了帮助您更快、更好地完成工作的工具。
立即更新,体验不同:
npm install -g @aigne/cli@latest