chapter-analyzer
验证 Docusaurus MDX 章节结构
Docusaurus 章节质量参差不齐，难以保持一致的教育内容。此技能可验证 MDX 章节的结构完整性、教学流程和正确的组件使用，确保每个章节都符合高标准的教育质量。
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "chapter-analyzer". 使用 chapter-analyzer 验证 textbook/docs/intro-to-ros.mdx
النتيجة المتوقعة:
- YAML 前置数据有效（存在 id、title、sidebar_label、description）
- 介绍后缺少学习目标部分
- 未找到互动的 Quiz 或 Simulation 组件
- 标题层级正确（H1 标题，H2+ 正文内容）
- 总结部分包含要点回顾
- 考虑为 Python/C++ 代码示例添加 Tabs 组件
استخدام "chapter-analyzer". 检查 textbook/docs/python-fundamentals.mdx 的教育内容质量
النتيجة المتوقعة:
- 所有必填的前置数据字段都存在且非空
- 章节开头发现介绍引导语
- 检测到带有项目符号的学习目标部分
- 发现多个带有语言标签的代码示例
- 核心内容部分存在 Quiz 组件
- 总结部分回顾了关键概念
التدقيق الأمني
آمنPure documentation skill containing only markdown content. All 28 static findings are false positives caused by misconfigured scanner triggering on markdown syntax (backticks, code blocks, component tags). No executable code, network calls, filesystem operations, or external commands exist.
عوامل الخطر
🌐 الوصول إلى الشبكة (1)
📁 الوصول إلى نظام الملفات (1)
⚙️ الأوامر الخارجية (10)
درجة الجودة
ماذا يمكنك بناءه
维护文档标准
确保所有提交的章节在发布前遵循一致的结构和质量指南。
验证学习内容
验证教育章节是否包含适当的学习目标和互动元素。
执行 MDX 最佳实践
在 CI 流程中自动执行章节验证，以大规模维护文档质量。
جرّب هذه الموجهات
使用 chapter-analyzer 验证 textbook/docs/getting-started.mdx 的 YAML 前置数据和标题结构。
运行 chapter-analyzer 验证 textbook/docs/ros2-basics.mdx 是否包含必需的 Quiz 或 Simulation 组件。
应用 chapter-analyzer 分析 textbook/docs/advanced-topics.mdx 的教学质量，包括学习目标和总结部分。
对 textbook/docs/ 中的所有 MDX 文件执行 chapter-analyzer，并生成任何结构或质量问题的报告。
أفضل الممارسات
- 在提交新的或修改的文档之前，始终运行 chapter-analyzer 以便及早发现问题。
- 在所有章节中使用一致的 sidebar_label 以提高导航清晰度。
- 每个主要部分至少包含一个互动元素（Quiz 或 Simulation）以提升参与度。
تجنب
- 在章节正文中使用 H1 标题（应仅使用 H2 及更深层级）。
- 跳过学习目标部分（违反教学要求）。
- YAML 前置数据不完整或使用非描述性的描述。
الأسئلة المتكررة
此技能支持哪些文件格式？
哪些前置数据字段是必填的？
تفاصيل المطور
المؤلف
AbdulSamad94الترخيص
MIT
المستودع
https://github.com/AbdulSamad94/Hackhaton-SpecsKitPlus/tree/master/.claude/skills/chapter-analyzerمرجع
master
بنية الملفات
📄 SKILL.md