docs: 优化 skill 文档并添加更新原则
优化 skill/SKILL.md 遵循 Claude Skill 构建指南: - 重写 YAML frontmatter,添加触发词和 compatibility 字段 - 新增 Purpose、When to Use、Quick Reference、Workflow 章节 - 说明双路径执行策略(lyxy-runner-python 优先,回退主机 Python) - 修正依赖说明,使用具体 pip 包名 在 README.md 中添加 Skill 文档规范章节,明确更新原则 新增 openspec/specs/skill-documentation/ 规范文件
This commit is contained in:
33
README.md
33
README.md
@@ -41,6 +41,39 @@ uv run mypy .
|
||||
- 错误处理:自定义异常 + 清晰信息 + 位置上下文
|
||||
- Git 提交:类型: 简短描述(feat/fix/refactor/docs/style/test/chore)
|
||||
|
||||
## Skill 文档规范
|
||||
|
||||
skill/SKILL.md 面向 AI 用户,必须遵循 Claude Skill 构建指南的最佳实践:
|
||||
|
||||
### YAML frontmatter
|
||||
|
||||
- **name**: kebab-case 格式
|
||||
- **description**: 包含功能说明、触发词、文件类型、典型任务
|
||||
- **license**: MIT
|
||||
- **metadata**: 包含 version、author
|
||||
- **compatibility**: 说明 Python 版本要求和依赖情况
|
||||
|
||||
### 文档章节结构
|
||||
|
||||
1. **Purpose**: 说明统一入口和双路径执行策略
|
||||
2. **When to Use**: 典型场景和触发词列表(中英文、文件扩展名)
|
||||
3. **Quick Reference**: 命令参数表格
|
||||
4. **Workflow**: 4 步工作流程(检测环境、识别类型、执行解析、输出结果)
|
||||
5. **使用示例**: 各文档类型的基本用法和高级用法
|
||||
6. **错误处理**: 常见错误及解决方案
|
||||
7. **References**: 指向项目文档的链接
|
||||
|
||||
### 双路径执行策略
|
||||
|
||||
- **优先**: 使用 lyxy-runner-python skill(自动管理依赖)
|
||||
- **回退**: 主机 Python 环境(需手动安装依赖)
|
||||
|
||||
### 依赖说明
|
||||
|
||||
- 必须使用具体的 pip 包名
|
||||
- 不能使用 lyxy-document[xxx] 形式(发布时没有 pyproject.toml)
|
||||
- 按文档类型分组说明
|
||||
|
||||
## 解析器架构
|
||||
|
||||
### DOCX
|
||||
|
||||
Reference in New Issue
Block a user