想知道您的文档是否达到了标准？本指南将介绍 evaluate 命令，这是一个强大的工具，可以系统地评估您文档的质量和完整性，并提供清晰、可操作的报告来指导您进行改进。您将学习如何运行评估并解读其结果。
评估流程
evaluate 命令执行全面的两阶段分析，让您全面了解文档的健康状况。它会检查每个文件的高层组织结构和细粒度细节。
结构评估
首先，该工具会检查您文档的整体架构。它会验证主题层次结构是否逻辑清晰，并完全覆盖您在初始设置中定义的目标、受众和深度。
内容评估
接下来，它会深入到每个单独的文档中。此阶段根据可读性、连贯性以及与您陈述的目的的一致性等维度评估书面内容的质量。它还会验证任何代码片段的正确性。
两个阶段都完成后，评估结果会被汇编成一份详细的 HTML 报告，其中提供了分数、指出了具体问题，并提供了可操作的反馈。
如何运行评估
要开始评估过程，您只需在项目的根目录中运行一个命令。
执行命令
打开您的终端并执行 evaluate 命令。
aigne doc evaluate
aigne doc evaluate默认情况下，该命令在完成后会自动在您的网页浏览器中打开生成的 HTML 报告。要阻止此行为，您可以添加 --open false 标志。
aigne doc evaluate --open false
aigne doc evaluate --open false查看输出
当命令运行时，它会显示其进度。完成后，终端中会显示一条确认消息，提供报告文件的路径。
✔ Generate evaluation report
Evaluation report generated successfully.
- JSON Report: .aigc/evaluate/20240520114500/integrity-report.json
- HTML Report: .aigc/evaluate/20240520114500/report.html您可以直接在浏览器中打开 report.html 文件以查看详细的分析。
理解评估报告
报告的结构清晰，有条理地分解了评估结果，使您可以轻松地找出需要关注的领域。
结构评估详情
本节重点关注您文档的高层组织结构。它评估文档结构与项目定义的目标的契合程度。
| 维度 | 描述 |
|---|---|
| 目的覆盖率 | 评估文档结构是否充分支持主要目标，例如“快速入门”或“完成特定任务”。 |
| 受众覆盖率 | 判断结构是否为预期的目标受众（如“最终用户（非技术人员）”）进行了逻辑组织。 |
| 深度覆盖率 | 检查结构所隐含的细节层次是否与所选的内容深度相匹配，例如“涵盖所有参数”。 |
文档内容评估详情
本节提供了对内容质量的逐文件分析。每个文档都根据一组标准化标准进行评分，以确保其符合质量标准。
| 维度 | 描述 |
|---|---|
| 可读性 | 衡量文本阅读和理解的难易程度。 |
| 连贯性 | 评估文档中主题的逻辑流程和组织。 |
| 内容质量 | 评估所提供信息的准确性、相关性和清晰度。 |
| 一致性 | 检查所有文档中术语、格式和风格的统一使用。 |
| 目的对齐 | 判断内容在多大程度上实现了指定的文档目标。 |
| 受众对齐 | 评估语言、语调和示例是否适合目标受众。 |
| 知识水平对齐 | 验证内容的复杂性是否与定义的读者知识水平相匹配。 |
总结
定期使用 evaluate 命令是维护高质量文档的关键实践。它提供了客观的指标和具体的反馈，让您能够有条不紊地完善您的内容。在审查报告后，您可以进行有针对性的改进，以确保您的文档尽可能清晰有效。
有关如何应用报告反馈的详细说明，请参阅更新文档指南。