Files
dz3ai a1ef780467 add Chinese docs (#232)
* add Chinese docs

* docs: Add missing Chinese translations and update README.zh-CN.md links

- Add 4 new Chinese translation files:
  - contributors/examples.md: Real-world examples of using skills
  - maintainers/audit.md: Repository coherence and correctness audit guide
  - maintainers/ci-drift-fix.md: CI drift fix guide
  - users/visual-guide.md: Visual quick start guide with diagrams

- Update README.zh-CN.md to replace docs/ links with docs_zh-CN/ links for:
  - Navigation section
  - Documentation table
  - Contributing section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-08 08:35:17 +01:00

394 lines
9.0 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 技能质量标准
## 概述
本文档定义了Antigravity Awesome Skills项目中技能的质量标准和评估标准。所有提交的技能都必须满足这些标准才能被接受。
---
## 质量维度
### 1. 内容质量Content Quality
**必须满足:**
-**准确性**:技术信息正确,无错误概念
-**完整性**:涵盖主要使用场景,步骤完整
-**清晰性**:语言简洁明了,逻辑清楚
-**实用性**:解决实际问题,有明确价值
**评分标准:**
- **优秀5分**:超出预期,包含高级技巧和深度见解
- **良好4分**:满足所有要求,内容详实
- **合格3分**:基本要求满足,功能完整
- **改进2分**:部分要求满足,需要补充
- **不合格1分**:严重缺陷,需要重写
### 2. 格式规范Format Standards
**前置内容要求:**
-`name`:小写+连字符,与目录名匹配
-`description`200字符以内简洁明确
-`category`:正确的分类标识
-`risk`:合适的风险级别
-`date_added`YYYY-MM-DD格式
- ✅ 必需字段完整,无拼写错误
**内容结构要求:**
- ✅ 标准章节结构(概述、使用场景、工作原理等)
- ✅ 代码块语法正确
- ✅ 链接有效且格式正确
- ✅ 技能引用使用`@skill-name`格式
### 3. 技术质量Technical Quality
**代码示例要求:**
- ✅ 代码可运行,语法正确
- ✅ 遵循语言最佳实践
- ✅ 包含必要的错误处理
- ✅ 性能考虑合理
**安全性要求:**
- ✅ 无已知安全漏洞
- ✅ 输入验证完整
- ✅ 敏感信息处理得当
- ✅ 安全最佳实践遵循
### 4. 用户体验User Experience
**易用性要求:**
- ✅ 新手能理解和跟随
- ✅ 步骤清晰,可操作性
- ✅ 预期结果明确
- ✅ 故障排除信息充分
**学习价值要求:**
- ✅ 教学价值明确
- ✅ 概念解释清楚
- ✅ 示例覆盖主要场景
- ✅ 最佳实践指导
---
## 评估流程
### 1. 自动化检查
**运行命令:**
```bash
npm run validate:skill skills/skill-name/
npm run validate:frontmatter skills/skill-name/SKILL.md
npm run check-links skills/skill-name/SKILL.md
```
**检查项目:**
- 前置内容格式验证
- YAML语法检查
- 必需字段完整性
- 内部链接有效性
- 重复技能检测
### 2. 人工评估
**评估维度:**
- **技术准确性**:专家审核技术内容
- **实用价值**:评估解决实际问题的能力
- **内容质量**:评估写作质量和组织结构
- **创新性**:评估技能的独特性和创新点
**评估流程:**
1. 技术专家审核(必需)
2. 维护者综合评估(必需)
3. 社区反馈收集(可选)
4. 最终质量决策(必需)
### 3. 质量分数计算
**权重分配:**
- 内容质量40%
- 格式规范20%
- 技术质量25%
- 用户体验15%
**合格标准:**
- 总分 ≥ 3.0满分5分
- 无"不合格"维度
- 安全性必须"合格"或以上
---
## 不同质量等级的要求
### 🌟 优秀技能4.5-5.0分)
**内容要求:**
- 超出基本需求的深度内容
- 包含高级技巧和专家见解
- 多个复杂示例和边界情况处理
- 完整的故障排除指南
**格式要求:**
- 完美的格式规范
- 丰富的代码注释
- 详细的性能考虑
- 优秀的学习路径设计
**技术要求:**
- 生产级代码质量
- 全面的安全考虑
- 优秀的性能表现
- 完整的错误处理
**示例:**
```markdown
## 高级技巧
这里提供一些专家级别的优化技巧...
## 性能考虑
在大型应用中,需要注意以下性能点...
```
### 🎯 良好技能3.5-4.4分)
**内容要求:**
- 满足所有核心需求
- 内容详实且准确
- 适当的使用示例
- 基本的故障排除
**格式要求:**
- 遵循所有格式规范
- 代码示例正确
- 链接有效
- 结构清晰
**技术要求:**
- 代码质量良好
- 基本安全考虑
- 合理的性能处理
- 适当错误处理
### ✅ 合格技能3.0-3.4分)
**内容要求:**
- 基本功能完整
- 主要使用场景覆盖
- 基本准确性保证
- 简单示例提供
**格式要求:**
- 基本格式正确
- 前置内容完整
- 基本结构符合
**技术要求:**
- 代码基本可用
- 无明显安全问题
- 基本错误处理
### ⚠️ 改进技能2.0-2.9分)
**需要改进的常见问题:**
- 内容不够详细或不够准确
- 示例不完整或有错误
- 格式部分不符合要求
- 技术实现有待改进
**改进建议:**
- 补充缺失的使用场景
- 修正代码示例错误
- 完善格式规范
- 增强技术实现
### ❌ 不合格技能(<2.0分)
**严重问题示例:**
- 技术信息错误
- 内容不完整
- 格式严重不符
- 安全问题存在
**处理方式:**
- 直接拒绝,提供详细反馈
- 要求重大修改后重新提交
- 建议参考高质量技能学习
---
## 具体质量标准
### 安全技能质量标准
**额外要求:**
- ✅ 安全风险评估完整
- ✅ 漏洞扫描方法可靠
- ✅ 修复建议实用可行
- ✅ 合规要求明确
**安全等级分类:**
- **低风险Safe**:代码审查、文档指导
- **中等风险Medium**:系统配置、数据处理
- **高风险High**:生产环境修改、安全测试
### AI技能质量标准
**额外要求:**
- ✅ 提示工程技巧专业
- ✅ AI伦理考虑充分
- ✅ 模型适用范围明确
- ✅ 输出质量控制方法
**特殊评估项:**
- 提示质量优化效果
- 上下文管理策略
- 错误恢复机制
- 性能和成本考虑
### 前端技能质量标准
**额外要求:**
- ✅ 兼容性考虑全面
- ✅ 性能优化策略有效
- ✅ 用户体验细节到位
- ✅ 现代最佳实践遵循
**技术评估重点:**
- 组件设计模式
- 状态管理策略
- 构建和部署流程
- 测试覆盖度
### 后端技能质量标准
**额外要求:**
- ✅ API设计符合规范
- ✅ 数据处理安全高效
- ✅ 可扩展性考虑充分
- ✅ 监控和日志完整
**架构评估重点:**
- 系统设计合理性
- 数据库设计优化
- 安全架构完整性
- 性能和可维护性
---
## 质量提升指导
### 常见问题及解决方案
**1. 内容过于简单**
- 问题:只有基础信息,缺乏深度
- 解决:添加高级技巧、边界情况处理、最佳实践
**2. 示例代码错误**
- 问题:代码无法运行或有语法错误
- 解决:实际测试每个示例,添加完整上下文
**3. 格式不规范**
- 问题:前置内容缺失或格式错误
- 解决:严格遵循模板,运行验证工具
**4. 缺乏实际价值**
- 问题:理论过多,实用性不足
- 解决:增加真实场景示例,提供可操作指导
### 质量改进建议
**内容改进:**
- 增加更多实际使用案例
- 提供详细的故障排除指南
- 添加性能优化建议
- 包含最佳实践总结
**格式改进:**
- 使用更清晰的章节结构
- 添加更多代码注释
- 改进示例的实用性
- 增强可读性
**技术改进:**
- 优化代码质量和性能
- 增强安全性考虑
- 完善错误处理
- 提供扩展性指导
---
## 评估工具和资源
### 自动化工具
**质量检查工具:**
```bash
# 运行所有质量检查
npm run quality:check skills/skill-name/
# 生成质量报告
npm run quality:report skills/skill-name/
# 比较质量指标
npm run quality:compare skills/skill-name/
```
**检查项目:**
- 内容深度分析
- 代码质量评估
- 安全性扫描
- 性能基准测试
### 评估资源
**参考标准:**
- [技能结构指南](skill-anatomy.md)
- [代码规范指南](coding-standards.md)
- [安全最佳实践](security-best-practices.md)
- [性能优化指南](performance-guidelines.md)
**质量模板:**
- [优秀技能示例](examples/excellent-skill/)
- [常见错误示例](examples/common-mistakes/)
- [改进前后的对比](examples/before-after/)
---
## 社区参与
### 质量反馈机制
**用户反馈渠道:**
- GitHub Issues中的质量问题
- Discord中的技能讨论
- 社区调查和评分
- 使用统计和性能数据
**反馈处理流程:**
1. 收集和分类反馈
2. 评估影响和优先级
3. 制定改进计划
4. 实施改进并验证
5. 通知相关贡献者
### 持续改进
**质量监控指标:**
- 技能使用频率和成功率
- 用户满意度和评分
- 社区贡献和改进建议
- 技术债务累积情况
**定期质量审查:**
- 月度质量报告
- 季度标准更新
- 年度质量目标调整
- 持续流程优化
---
## 总结
这个质量标准确保了Antigravity Awesome Skills项目中每个技能都能为用户提供高质量、实用、安全的价值。通过明确的标准、严格的评估流程和持续的改进机制我们建立了技能质量的信任和可靠性。
所有贡献者都应该仔细阅读并遵循这些标准,在提交技能前进行自我评估。维护者将根据这些标准进行公平、透明的评估。
如果您对质量标准有任何疑问或建议,欢迎参与社区讨论或联系维护团队。🚀