教育
book-metrics-generator avatar

book-metrics-generator

為 MkDocs Material 智慧教科書生成定量指標與進度報告,包含章節統計、內容容量及教育元素計算。

簡介

book-metrics-generator 是一款專為使用 MkDocs Material 框架編寫智慧教科書的作者與教育工作者所設計的診斷工具。它是一個綜合性的審計實用程式,透過量化教育、技術與結構組件來追蹤課程內容的開發生命週期。透過對專案目錄執行自動化掃描,該技能能提供有關內容密度、完整性與教學分配的可行性洞察,對於專案狀態報告及發布前的品質保證至關重要。

  • 自動生成包含整體專案統計數據的 book-metrics.md,以及用於細粒度、章節級效能拆解的 chapter-metrics.md。

  • 分析特定的教育組件,包含來自 CSV 圖表的學習概念、術語表密度、常見問題 (FAQ) 覆蓋率,以及各章節測驗問題的數量。

  • 評估視覺與互動資產的技術指標,例如圖表、基於 LaTeX 的方程式以及 p5.js MicroSims,以確保符合學習參與度的基準。

  • 根據字數與組件密度(圖表與模擬)計算實體頁面等效值,幫助團隊追蹤專案範圍與規模。

  • 透過遵循 docs/chapters、docs/sims 與根目錄 Markdown 檔案中的一致檢測模式,在多個教科書專案間標準化報告。

  • 非常適合開發複雜、多章節數位教科書的教育內容開發者、技術寫作人員與教學設計師使用。

  • 適用於多種實務場景,例如:評估重大修訂週期後的內容完整性、比較隨時間變化的指標以識別成長趨勢,以及為利益相關者準備說明文件。

  • 使用前提是具備標準的智慧教科書結構,包含定義好的章節與支援檔案(如 learning-graph.csv、glossary.md 與 quiz.md)。

  • 使用者需注意其基於正規表達式 (regex) 的檢測模式:它會計算詞彙表與 FAQ 的 H2/H3 標題,識別 H4 的「Diagram:」標題,並排除程式碼區塊以確保字數統計反映的是敘述內容而非程式邏輯。

  • 輸出內容包含可直接對應至 mkdocs.yml 導航的整合表格,確保您的專案指標始終對學生與協作者可見且易於存取。

倉庫統計

Star 數
66
Fork 數
10
Open Issue 數
1
主要語言
Python
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 上午02:21
在 GitHub 查看