想知道您的文件是否達標嗎？本指南將介紹 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 指令是維護高品質文件的關鍵實踐。它提供客觀的指標和具體的回饋，讓您能有條不紊地完善您的內容。在檢視報告後，您可以進行針對性的改進，以確保您的文件盡可能清晰有效。
有關如何應用報告回饋的詳細說明，請參閱更新文件指南。