Skills 最佳实践
最佳实践(Best Practices)
Skill 编写
1. 清晰的描述和命名
描述要具体:
- 明确说明 Skill 的用途和适用场景
- 包含关键词,帮助 AI 准确识别
- 说明前置条件和预期结果
命名要规范:
- 使用清晰、描述性的名称
- 可以添加分类前缀(如
k8s-、docker-、git-) - 保持命名风格一致
2. 结构化的操作步骤
逻辑清晰:
- 按执行顺序组织步骤
- 使用编号或列表明确步骤顺序
- 添加必要的判断和分支
详细具体:
- 包含完整的命令和参数
- 说明每个步骤的目的
- 提供示例和预期输出
3. 错误处理和回滚
异常处理:
- 识别可能的错误情况
- 提供错误处理步骤
- 说明如何判断操作成功或失败
回滚机制:
- 对于可能造成影响的操作,提供回滚步骤
- 说明如何恢复到操作前的状态
4. 可维护性
使用变量:
- 避免硬编码特定值
- 使用占位符提高灵活性
- 说明变量的含义和取值范围
模块化设计:
- 将复杂流程拆分为多个步骤
- 每个步骤职责单一
- 便于单独测试和修改
性能优化
1. Skill 数量控制
合理启用:
- 只启用当前需要的 Skills
- 避免同时启用过多 Skills
- 定期清理不使用的 Skills
按需加载:
- 根据工作场景切换 Skills
- 使用 Skill 分组功能
- 建立不同场景的 Skill 集合
2. Skill 内容优化
精简步骤:
- 移除不必要的步骤
- 合并可以并行执行的步骤
- 优化命令执行顺序
减少复杂度:
- 避免过于复杂的逻辑判断
- 将复杂 Skill 拆分为多个简单 Skills
- 使用资源文件存储大量内容
参考资料(Resources)
Terminal Skills 官方仓库
- GitHub:chaterm/terminal-skills
- 说明:专为终端工作流设计的 Skills 综合集合,包含各种运维、开发场景的 Skills