SuperAPI AI 工具集

skill-doc-generator

编程与开发

查看项目

更新于 10-16 10:22

技能介绍

本工具用于为技能自动生成标准化 README 文档,并提供一致性校验与示例生成,帮助维护技能文档的统一性。

主要用途:从 SKILL.md 分析结构与示例、校验质量规范、生成完整文档。

核心脚本与用法: 分析单个技能:python scripts/analyze_skill.py <skill_directory>,提取元数据、章节结构、代码块与引用资源等。 校验一致性:python scripts/validate_consistency.py <skill_directory> --verbose,检查 frontmatter、描述质量与术语。 生成 README:python scripts/generate_readme.py <skill_directory> [output_path]。 批量处理:python scripts/document_directory.py <directory> [options],支持 --output <dir>、--no-recursive、--no-index、--no-validate。

校验标准包括:frontmatter 名称小写带连字符、描述 50-500 字符且含触发词、正文至少 100 字符且建议少于 500 行、资源需被引用、使用祈使句并统一大小写“Claude”、避免模糊词汇。严重级别分 ERROR、WARNING、INFO。参考文件 readme-template.md、consistency-rules.md、terminology-standards.md 定义模板与规范。

适用场景:技能创建时生成文档、质量审计、SKILL.md 更新后重新生成、批量整理技能库以及 CI/CD 自动化校验。

限制:资料未提供具体运行环境、依赖版本、错误恢复细节与收费信息。