lanyuanxiaoyao
277c14d2e8
- 更新 compatibility 字段，移除三路径执行优先级说明 - 删除 "执行路径优先级" 章节，统一为脚本自启动方式 - 更新 openspec/skill-documentation spec，移除三路径执行策略需求
68 lines
2.8 KiB
Markdown
68 lines
2.8 KiB
Markdown
## ADDED Requirements
|
||
|
||
### Requirement: SKILL.md 遵循 Claude Skill 构建指南
|
||
SKILL.md 文档必须遵循 Claude 官方 Skill 构建指南的最佳实践，包括渐进式披露的三级系统、清晰的触发词和完整的章节结构。
|
||
|
||
#### Scenario: Claude 正确加载 skill
|
||
- **WHEN** 用户询问与文档解析相关的问题
|
||
- **THEN** Claude 应根据 YAML frontmatter 中的触发词自动加载此 skill
|
||
|
||
#### Scenario: AI 了解 skill 的用途
|
||
- **WHEN** skill 被加载
|
||
- **THEN** AI 应能从 Purpose 和 When to Use 章节了解何时使用此 skill
|
||
|
||
### Requirement: YAML frontmatter 包含完整元数据
|
||
YAML frontmatter 必须包含 name、description（带触发词）、license 和 compatibility 字段。
|
||
|
||
#### Scenario: description 包含触发词
|
||
- **WHEN** 查看 YAML frontmatter
|
||
- **THEN** description 应包含功能说明、触发条件和用户可能说的具体任务
|
||
|
||
#### Scenario: compatibility 说明依赖和 Python 版本
|
||
- **WHEN** 查看 YAML frontmatter
|
||
- **THEN** compatibility 应说明 Python 版本要求和脚本自启动特性
|
||
|
||
### Requirement: 推荐用法
|
||
SKILL.md 必须说明直接运行 `python scripts/lyxy_document_reader.py` 即可，脚本会自动检测文件类型、当前平台，并用正确的 uv 命令执行。
|
||
|
||
#### Scenario: 直接运行脚本
|
||
- **WHEN** AI 需要执行文档解析
|
||
- **THEN** 运行 `python scripts/lyxy_document_reader.py <文件路径或URL>`
|
||
|
||
#### Scenario: 脚本自动检测
|
||
- **WHEN** 运行脚本
|
||
- **THEN** 脚本自动检测文件类型、当前平台，并用正确的 uv 命令执行
|
||
|
||
### Requirement: 文档包含关键章节
|
||
SKILL.md 必须包含 Purpose、When to Use、Quick Reference、参数使用示例等章节，遵循渐进式披露原则。
|
||
|
||
#### Scenario: 快速查找用法
|
||
- **WHEN** AI 需要了解如何使用此 skill
|
||
- **THEN** Quick Reference 表格提供命令参数概览
|
||
|
||
#### Scenario: 了解参数用法
|
||
- **WHEN** AI 需要了解参数用法
|
||
- **THEN** 参数使用示例章节提供简洁的命令示例
|
||
|
||
### Requirement: 触发词覆盖多种表达方式
|
||
description 和 When to Use 章节必须包含中文和英文的触发词，以及文件扩展名。
|
||
|
||
#### Scenario: 中文触发词
|
||
- **WHEN** 用户说"读取文档"、"解析 Word"、"打开 PDF"等
|
||
- **THEN** skill 应被触发
|
||
|
||
#### Scenario: 文件扩展名触发
|
||
- **WHEN** 用户上传 .docx、.xlsx、.pptx、.pdf、.html 文件
|
||
- **THEN** skill 应被触发
|
||
|
||
### Requirement: 错误处理指引
|
||
文档必须包含常见错误的处理方法，帮助用户排查问题。
|
||
|
||
#### Scenario: 依赖缺失错误
|
||
- **WHEN** 出现 ModuleNotFoundError
|
||
- **THEN** 错误处理表格说明脚本会自动检测并安装依赖
|
||
|
||
#### Scenario: 文件类型不支持
|
||
- **WHEN** 出现"不支持的文件类型"错误
|
||
- **THEN** 错误处理表格说明检查文件扩展名
|