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