跳到主要内容

DocSmith 0.9.8 版发布:AI 图表生成与评估能力提升

Pengfei Zhu
AIGNEDocSmithProduct Release

AIGNE DocSmith 发布了一个新的 Beta 版,为开发者和团队引入了两项重要的核心功能。1. AI图表生成:高效简化专业图表创作,助力文档阅览体验与视觉呈现升级 2. 增强的评估功能:全局视角评估,提供更全面的质量分析## 主要功能### 1. AI 图表生成> 版本要求:此功能需要 AIGNE CLI 1.57.2 或更高版本。请确保您的 CLI 版本符合此要求。以下是来自 AIGNE DocSmith 文档 的使用示例:image.png#### 功能描述AI 会自动分析文档内容,判断是否需要插入图表以及插入位置,并根据上下文自动生成对应的架构图、流程图等各类图表。整个过程无需手动指定位置或内容。##### 核心能力- 根据内容分析,确定图表的恰当位置

  • 根据上下文选择图表类型:流程图、架构图、概念图、序列图、网络图
  • 自动选择视觉风格(现代、标准、手绘、扁平、极简或 3D 风格等)和最佳宽高比
  • 生成符合 Material Design 规范的图表
  • 自动优化图像大小并同步到所有翻译版本的文档中### 用法

目标命令
通过交互式反馈更新单个文档aigne doc update
选择包含图表的文档aigne doc update --diagram
更新所有包含图表的文档aigne doc update --diagram-all

注意: --diagram--diagram-all 适用于批量操作。对于单个文档,请使用 aigne doc update 命令并进行交互式反馈。### 示例:交互式反馈当运行 aigne doc update 时,您可以请求特定的图表修改:```javascript Feedback: "Add architecture diagram to the deployment section" Result: Diagram inserted at identified location, style: modern

Feedback: "Change the flowchart to hand-drawn style" Result: Chart regenerated with hand-drawn style

Feedback: "Delete the diagram in section 3" Result: Diagram removed

更新后的图表会自动同步至所有译文文档。####
- 检查文档间的关联性和一致性
- 识别术语、风格和格式的不一致问题
- 发现重复内容和缺失的关联
- 识别文档间的依赖关系问题
- 建议更好的文档组织结构##### 评估维度:系统在审查文档时会考量以下几个因素,包括:- <strong>可读性</strong> — 语言清晰度、语法、拼写
- <strong>连贯性</strong> — 逻辑流畅、过渡、一致性
- <strong>内容质量</strong> — 覆盖范围、准确性、可操作性
- <strong>一致性</strong> — 术语、风格、格式统一
- <strong>目标对齐</strong> — 内容与目标的一致性
- <strong>受众契合度</strong> — 目标受众的适用性
- <strong>知识水平匹配</strong> — 与读者预期的知识水平保持一致#### 用法要开始使用评估器,只需使用以下命令,即可生成一份 .html 格式的报告。```javascript
aigne doc evaluate
```全局上下文默认启用。系统会收集所有文档内容,运行分析,并生成评估报告。## 升级指南### 版本要求- AI 图表生成功能:需要 AIGNE CLI 版本 1.57.2 或更高。
- 请确保您的 CLI 版本符合要求,否则图表生成功能可能无法按预期运行。### 升级步骤#### 1. 检查 CLI 版本```javascript
aigne --version
```请确认版本至少为 1.57.2。如果版本过低,请先升级 CLI:```javascript
npm install -g @aigne/cli@latest
# 或
pnpm add -g @aigne/cli@latest
```#### 2. 入门- 图表生成:运行 `aigne doc update --diagram`  即可开始(需要 CLI 版本 >= 1.57.2)
- 增强评估:运行 `aigne doc evaluate`,即可进行全面的全局评估#### 3. 可选配置为了自定义图表样式,请在 `aigne.yaml` 中添加 `diagramming` 配置(参见上方使用指南)。## 摘要版本 0.9.8 新增:- <strong>AI 图表生成</strong> — 自动创建并排布图表(要求 CLI ≥1.57.2)
- <strong>增强评估</strong> — 结合全局上下文的跨文档分析更新您的 CLI,即可使用图表功能。前往 [https://docsmith.aigne.io](https://docsmith.aigne.io),即刻体验并查看实时文档站点。

本页涉及

产品

  • AIGNE active

    面向开发者的 agent 开发框架。从命令行创建并运行一个项目,需要细节时再查框架文档。

  • DocSmith superseded

    让文档跟着它描述的代码一起生成和维护,包括多语言版本。这部分工作已并入 ARC;独立工具不再维护。