名称: 技能文档生成器描述: 从SKILL.md文件自动生成标准化的README文档，验证一致性（前端元数据、描述、术语），并创建使用示例。用于记录单个技能、在目录中为多个技能生成文档，或验证技能质量标准。

技能文档生成器

自动生成高质量技能README文档，内置一致性验证和示例生成功能。

概述

该技能通过分析SKILL.md文件，自动创建标准化的README文件，提取结构和示例，验证质量标准，并生成全面的文档。确保技能文档的一致性，同时提供可操作的验证反馈。

工作流程

单个技能文档生成

为一个技能生成文档：

分析技能：
```
python scripts/analyze_skill.py <技能目录>
```
提取元数据、部分、代码块和资源。
验证一致性：
```
python scripts/validate_consistency.py <技能目录> --verbose
```
检查前端元数据、描述质量和术语。

生成README：

python scripts/generate_readme.py <技能目录> [输出路径]

创建带有验证结果的README.md。

批量文档生成

一次性为多个技能生成文档：

python scripts/document_directory.py <目录> [选项]

选项：

--output <目录>：指定输出目录
--no-recursive：不搜索子目录
--no-index：跳过索引文件生成
--no-validate：跳过验证检查

示例：

# 为所有用户技能生成文档并进行验证
python scripts/document_directory.py /mnt/skills/user --output ./docs

# 快速跳过验证生成文档
python scripts/document_directory.py ./my-skills --no-validate

脚本参考

analyze_skill.py

解析SKILL.md并提取结构化信息。

用法：python scripts/analyze_skill.py <技能目录>

元数据（名称、描述）
部分和结构
带有语言标签的代码块
引用的资源（脚本、参考、资产）
统计信息（行数、部分计数）

validate_consistency.py

根据references/consistency-rules.md中定义的标准验证技能质量。

用法：python scripts/validate_consistency.py <技能目录> [--verbose]

检查：

前端元数据完整性和格式
描述质量（长度、清晰度、触发条件）
结构适当性
术语一致性
资源引用
代码示例质量

严重性级别：

错误：破坏功能（缺少必填字段）
警告：质量问题（命名、未引用资源）
信息：建议（风格、可选改进）

generate_readme.py

从技能分析创建README.md。

用法：python scripts/generate_readme.py <技能目录> [输出路径]

生成：

标题和描述
从SKILL.md提取的概述
触发场景
结构统计信息
捆绑资源列表及链接
关键部分概述
使用示例（最多3个）
验证结果（可选）

模板：请参考references/readme-template.md了解结构。

document_directory.py

批量处理目录中的多个技能。

用法：python scripts/document_directory.py <目录> [选项]

功能：

递归发现技能
并行验证和文档生成
索引生成与分类
摘要统计
每个技能的错误处理

质量标准

验证强制执行以下标准：

前端元数据

名称：小写字母带连字符（例如 skill-name）
描述：50-500个字符，明确触发条件
必须以大写字母开头
包括“当”或“使用”短语

结构

正文：最少100个字符，建议少于500行
部分：推荐概述/工作流程
资源：SKILL.md中引用的所有文件

术语

使用祈使形式：“使用”而不是“您应该使用”
一致大写“Claude”
避免模糊术语：“各种”、“多个”
首选主动语态

请参考references/consistency-rules.md和references/terminology-standards.md了解完整标准。

参考文件

readme-template.md

标准README结构和最佳实践。定义：

必需部分
可选部分
格式指南
链接约定

consistency-rules.md

详细验证标准。涵盖：

前端元数据要求
描述质量指标
结构指南
资源验证
错误严重性定义

terminology-standards.md

标准词汇和风格指南。包括：

写作风格（祈使形式）
常见术语及其用法
应避免的短语
格式约定
一致性检查表

示例

示例1：生成单个技能文档

# 分析
python scripts/analyze_skill.py ./my-skill

# 验证
python scripts/validate_consistency.py ./my-skill --verbose

# 生成README
python scripts/generate_readme.py ./my-skill

示例2：批量处理并生成索引

# 为目录中的所有技能生成文档
python scripts/document_directory.py /mnt/skills/user \
  --output ./documentation \
  --recursive

示例3：快速验证跳过

# 仅进行验证不生成文档
python scripts/validate_consistency.py ./my-skill

常见用例

新技能创建：作为技能开发的一部分生成文档 质量审计：根据标准验证现有技能 文档更新：在SKILL.md更改后重新生成README 批量操作：为整个技能库生成文档 CI/CD集成：部署管道中的自动验证

提示

在生成文档之前运行验证以早期发现问题
使用 --verbose 标志查看信息级建议
参考文件提供验证规则背后的“为什么”
生成的README包含验证结果以提高透明度
索引文件帮助导航大型技能集合

名称: 技能文档生成器 描述: 从SKILL.md文件自动生成标准化的README文档，验证一致性（前端元数据、描述、术语），并创建使用示例。用于记录单个技能、在目录中为多个技能生成文档，或验证技能质量标准。