⚡

章节分析器Skill chapter-analyzer

章节分析器是一个用于自动化验证和评估Docusaurus文档项目（特别是MDX格式教材）质量的工具。它执行结构验证、内容规则检查、互动组件审计和语气分析，确保技术文档符合教学标准、结构清晰且用户体验良好。关键词：Docusaurus文档分析，MDX章节验证，技术文档质量，教学流程检查，自动化内容审计。

DevOps 0 次安装 0 次浏览 更新于 3/1/2026

name: 章节分析器 description: 验证和分析Docusaurus MDX章节的结构、教学质量和组件使用情况。

章节分析器逻辑

目标目录

  • 位置: textbook/docs/
  • 格式: MDX (.mdx 或 .md)

结构验证

每个章节必须包含有效的YAML前置元数据：

---
id: 我的章节id
title: 我的章节标题
sidebar_label: 侧边栏标签
description: 本章节的简要摘要。
---

内容规则

  1. 标题层级:
    • Docusaurus标题充当H1。
    • 内容从H2 (##) 开始。
    • 正文中不要使用H1 (#)。
  2. 教学流程:
    • 引言: 吸引读者。
    • 学习目标: 将要学习内容的要点。
    • 核心内容: 通过文本+图表/代码进行解释。
    • 互动元素: 每个主要部分至少包含一个测验或模拟。
    • 总结: 回顾关键点。

互动组件

我们在MDX中使用自定义组件：

  • <Quiz questions={[...]} />: 用于知识检查。
  • <Simulation type="ros2-node" ... />: 用于嵌入式模拟。
  • <Tabs> / <TabItem>: 用于多语言代码块（Python/C++）。

语气检查

  • 语气: 鼓励性、权威但易于理解。
  • 视角: “我们将学习”、“让我们一起探索”。
  • 清晰度: 避免使用未加解释的行话。