关于 your-skill-name
your-skill-name 是通用技能文档模板,并未描述具体的专业技能。它提供概念、使用场景、集成、测试、故障排查和维护等章节及占位示例。
主要功能
- 01技能简介与启用场景章节
- 02概念和模式文档章节
- 03集成与最佳实践章节
- 04测试与故障排查模板
- 05版本、维护和许可证章节
适用场景
- 01起草结构化的技能 README
- 02规划示例和指导内容的章节
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ nickcrew/ claude-cortex --skill your-skill-name安装后在 Claude Code 中输入/your-skill-name确认已加载。
详细介绍
技能标题
简要概述段落,说明此技能提供的内容、用途和范围。包括核心概念,以及此技能的价值所在。
何时使用此技能
列出应启用此技能的 5-10 个具体场景:
- 场景 1:具有明确触发条件的具体用例
- 场景 2:另一种不同的情况
- 场景 3:相关但不同的情境
- 场景 4:边缘情况或高级用法
- 场景 5:与其他工具/框架集成
核心概念
简要介绍理解此技能所需的基础概念。
概念 1:基础
通过简单示例说明第一个核心概念:
// Simple, clear example demonstrating concept
// Include comments explaining key points
要点:
- 重要方面 1
- 重要方面 2
- 重要方面 3
概念 2:构建模块
逐步介绍第二个核心概念,从基础到中级:
// Example showing concept application
// Demonstrate best practices
适用场景:
- 用例 1
- 用例 2
- 用例 3
常见模式
模式 1:[模式名称]
问题:描述此模式要解决的问题
解决方案:说明此模式的处理方式
示例:
// Complete, working example
// Well-commented to explain approach
// Include edge cases if relevant
function examplePattern() {
// Implementation details
// Show best practices
}
优点:
- 优势 1
- 优势 2
- 优势 3
缺点:
- 局限性 1
- 局限性 2
适用场景:应用此模式的具体条件
模式 2:[模式名称]
问题:第二个问题领域
解决方案:替代方案或互补方法
示例:
// Different approach showing variety
// Demonstrate trade-offs
比较:此模式与模式 1 的区别
高级用法
本节介绍适用于复杂场景的更深入模式。仅在需要时加载。
高级模式 1:[复杂场景]
说明何时需要使用高级用法:
// More sophisticated example
// Show integration with multiple concepts
// Demonstrate production-ready code
class AdvancedExample {
// Complete implementation
// Include error handling
// Show performance considerations
}
注意事项:
- 性能影响
- 可扩展性问题
- 安全影响
- 维护负担
高级模式 2:[边缘情况]
处理边缘情况和少见场景:
// Edge case handling
// Defensive programming
// Graceful degradation
集成示例
与[相关技术 1]集成
// Show how this skill integrates with other systems
// Practical, real-world example
与[相关技术 2]集成
// Different integration scenario
// Demonstrate flexibility
最佳实践摘要
快速参考,帮助有效实现此技能:
应做事项
- 这样做以获得最佳效果
- 始终考虑这一方面
- 尽可能优先采用这种方法
- 继续操作前验证此条件
- 记录此信息以便维护
不应做事项
- 避免这种反模式
- 切勿忘记这一关键步骤
- 切勿在生产环境中这样做
- 不要忽视这种边缘情况
- 避免这种常见错误
性能提示
- 优化技巧 1
- 优化技巧 2
- 缓存策略
- 资源管理
安全注意事项
- 安全实践 1
- 安全实践 2
- 输入验证要求
- 身份验证/授权问题
常见陷阱
陷阱 1:[常见错误]
问题:描述出现的问题
发生原因:解释根本原因
解决方案:如何避免或修复
// Incorrect approach (anti-pattern)
// badExample();
// Correct approach
// goodExample();
陷阱 2:[另一种错误]
问题:第二个常见问题
解决方案:预防策略
测试策略
单元测试
// Example test cases
// Show test structure
// Demonstrate assertions
describe('Feature', () => {
it('should handle expected case', () => {
// Test implementation
});
it('should handle edge case', () => {
// Edge case testing
});
});
集成测试
// Integration test example
// Show testing across boundaries
实际示例
示例 1:[实际场景]
背景:真实场景描述
实现:
// Complete, production-ready example
// Include error handling
// Show configuration
// Demonstrate best practices
class RealWorldExample {
// Full implementation
// Comments explaining decisions
// Edge case handling
}
结果:取得的结果和收益
示例 2:[不同场景]
背景:另一种用例
实现:
// Different approach for different context
经验教训:从此实现中获得的启示
故障排除
问题 1:[常见问题]
症状:用户观察到的现象
原因:典型根本原因
解决方案:
- 首选解决方案
- 替代方法
- 最后的补救方案
预防:如何避免此问题
问题 2:[另一个问题]
症状:可观察到的行为
诊断步骤:
- 首先检查此项
- 验证此条件
- 调查此方面
解决方法:如何修复
工具和资源
推荐工具
- 工具 1:功能介绍及适用场景
- 工具 2:替代工具及优缺点
- 工具 3:配套工具
库和框架
- 库 1:用途和集成方式
- 库 2:替代库对比
文档链接
延伸阅读
- 文章/书籍:简要介绍
- 教程:涵盖内容
- 视频课程:主要收获
版本历史
- 1.0.0 (2024-10-17):首次发布
- 实现核心模式
- 验证示例
- 编写最佳实践文档
相关技能
此技能与以下内容搭配使用效果良好:
- related-skill-1:它们如何相互补充
- related-skill-2:何时搭配使用
- related-skill-3:集成点
维护说明
作者承诺:预期更新频率和维护方式
欢迎贡献:社区贡献能发挥作用的领域
已知限制:当前不足或计划改进之处
弃用政策:如何处理破坏性变更
许可证
此技能采用 MIT License 许可。详情请参阅 LICENSE 文件。
作者联系信息
- 姓名:Your Name
- 邮箱:[email protected]
- GitHub:@yourusername
- 网站:https://yourwebsite.com(可选)
如有关于此技能的问题或疑问,请:
- 查看上方文档
- 搜索现有 GitHub 问题
- 创建新问题,并添加
community-skill:your-skill-name标签 - 如有紧急事项,请直接联系作者
评论
支持 Markdown