SuperAPI AI 工具集

book-metrics-generator

通用与其它

查看项目

更新于 10-16 04:31

技能介绍

用途:为基于 MkDocs Material 的智能教科书自动生成全书与分章指标报告,用于跟踪编写进度、准备状态汇报、评估出版前的内容完整性、分析教学元素分布、估算等效页数、审计重大更新后的内容,以及对比不同时间的指标变化。

主要能力:产出两份文件。book-metrics.md 为全书统计表,包含章节数、概念数(来自 learning-graph.csv)、术语数(glossary.md 中的 H2/H3 标题)、FAQ 数、测验题目总数、以“#### Diagram:”开头的图表数、LaTeX 公式、MicroSim 数、总词数与链接数,并按公式估算等效页数:Pages =(总词数 ÷ 250)+(图表数 × 0.25)+(MicroSim 数 × 0.5)。chapter-metrics.md 为分章表格,列出章号、章节标题、小节数、图表数与词数。

使用方式:需项目含 docs/、docs/chapters/ 及各章 index.md。可选 learning-graph.csv、glossary.md、faq.md、docs/sims/ 和每章 quiz.md。基本用法:在教科书项目根目录执行 ./scripts/book-metrics-generator.sh,或 bash /path/to/skill/scripts/book-metrics-generator.sh;自定义目录执行 ./scripts/book-metrics-generator.sh path/to/custom/docs;也可直接用 python3 scripts/book-metrics.py docs。生成后需在 mkdocs.yml 的 nav 中加入两份指标文件。

限制:仅面向 MkDocs Material 的智能教科书结构,依赖上述文件命名与目录约定;词数统计会排除代码块、行内代码与 URL;缺少目录或文件时相应计数为 0;等效页数为基于固定假设的估算值,非实际页数。扩展指标需在 Python 类中新增计数方法并更新 Markdown 生成逻辑。