Loading...
Loading...
Compare original and translation side by side
.claude/skills/[skill-name]/development-workflow/references/common-patterns.md.claude/skills/[skill-name]/development-workflow/references/common-patterns.mdOverall = (Structure × 0.20) + (Content × 0.25) + (Quality × 0.25) +
(Usability × 0.15) + (Integration × 0.15)综合评分 = (结构 × 0.20) + (内容 × 0.25) + (质量 × 0.25) +
(可用性 × 0.15) + (集成 × 0.15)scripts/validate-structure.pypython3 scripts/validate-structure.py /path/to/skill [--json] [--verbose]namedescription$ python3 scripts/validate-structure.py .claude/skills/todo-management
Structure Validation Report
===========================
Skill: todo-management
Date: 2025-11-06
✅ YAML Frontmatter: PASS
- Name format: valid (kebab-case)
- Trigger keywords: 8 found (target: 5+)
✅ File Structure: PASS
- SKILL.md: exists
- README.md: exists
- references/: 3 files found
- scripts/: 1 file found
✅ Naming Conventions: PASS
- All files follow conventions
⚠️ Progressive Disclosure: WARNING
- SKILL.md: 569 lines (good)
- state-management-guide.md: 501 lines (good)
- BUT: No Quick Reference section detected
Overall Structure Score: 4/5 (Good)
Issues: 1 warning (missing Quick Reference)
Recommendation: Add Quick Reference section to SKILL.mdscripts/validate-structure.pypython3 scripts/validate-structure.py /path/to/skill [--json] [--verbose]namedescription$ python3 scripts/validate-structure.py .claude/skills/todo-management
结构验证报告
===========================
技能: todo-management
日期: 2025-11-06
✅ YAML Frontmatter: 通过
- 名称格式: 有效(kebab-case)
- 触发关键词: 发现8个(目标: 5个以上)
✅ 文件结构: 通过
- SKILL.md: 存在
- README.md: 存在
- references/: 发现3个文件
- scripts/: 发现1个文件
✅ 命名规范: 通过
- 所有文件符合命名规范
⚠️ 渐进式披露: 警告
- SKILL.md: 569行(符合要求)
- state-management-guide.md: 501行(符合要求)
- 问题: 未检测到快速参考章节
整体结构评分: 4/5(良好)
问题: 1个警告(缺失快速参考章节)
建议: 在SKILL.md中添加快速参考章节Content Review: prompt-builder
==============================
Section Completeness: 9/10 ✅
✅ Overview: Present, clear explanation of purpose
✅ When to Use: 7 scenarios listed
✅ Main Content: 5-step workflow, well-organized
✅ Best Practices: 6 practices documented
✅ Quick Reference: Present
⚠️ Common Mistakes: Not present (optional but valuable)
Example Quality: 8/10 ✅
- Count: 12 examples (exceeds target of 5+)
- Concrete: Yes, all examples executable
- Helpful: Yes, demonstrate key concepts
- Minor: Could use 1-2 edge case examples
Content Clarity: 9/10 ✅
- Well-organized logical flow
- Clear explanations without verbosity
- Technical level appropriate
- Minor: Step 3 could be clearer (add diagram)
Documentation Completeness: 8/10 ✅
- All workflow steps documented
- Validation criteria clear
- Minor gaps: Error handling not covered
Content Score: 4/5 (Good)
Primary Recommendation: Add Common Mistakes section
Secondary: Add error handling guidance to Step 3内容评审: prompt-builder
==============================
章节完整性: 9/10 ✅
✅ 概述: 存在,清晰说明目标
✅ 适用场景: 列出7个场景
✅ 核心内容: 5步工作流,组织良好
✅ 最佳实践: 记录6条实践
✅ 快速参考: 存在
⚠️ 常见错误: 不存在(可选但有价值)
示例质量: 8/10 ✅
- 数量: 12个示例(超出5个以上的目标)
- 具体性: 是,所有示例均可执行
- 实用性: 是,演示核心概念
- 小问题: 可增加1-2个边缘场景示例
内容清晰度: 9/10 ✅
- 组织逻辑清晰
- 解释清晰且不冗长
- 技术难度合适
- 小问题: 步骤3可更清晰(添加图表)
文档全面性: 8/10 ✅
- 所有工作流步骤已记录
- 验证准则清晰
- 小空白: 未覆盖错误处理
内容评分: 4/5(良好)
主要建议: 添加常见错误章节
次要建议: 在步骤3中添加错误处理指导Quality Review: workflow-skill-creator
======================================
Pattern Compliance: ✅
- Pattern Detected: Workflow-based
- Implementation: Correct (5 sequential steps with dependencies)
- Consistency: High (all steps follow same structure)
Documentation Patterns: ✅
- 5 Core Sections: All present
- Structure: Consistent across all 5 steps
- Formatting: Proper heading levels
Best Practices Adherence: 8/10 ✅
✅ Validation checklists: Present and specific
✅ Examples throughout: 6 examples included
✅ Quick Reference: Present
⚠️ Error handling: Limited (only happy path in examples)
Anti-Pattern Detection: 1 detected ⚠️
✅ No keyword stuffing (15 natural keywords)
✅ No monolithic file (1,465 lines but has references/)
✅ Consistent structure
✅ Specific validation criteria
✅ Examples complete (no placeholders)
⚠️ Error cases: Only happy path documented
✅ Dependencies: Clearly documented
✅ Not over-engineered
Code Quality: N/A (no scripts)
Quality Score: 4/5 (Good)
Primary Issue: Limited error handling documentation
Recommendation: Add error case examples and recovery guidance质量评审: workflow-skill-creator
======================================
模式合规性: ✅
- 检测到的模式: 基于工作流
- 实现: 正确(5个带依赖的连续步骤)
- 一致性: 高(所有步骤遵循相同结构)
文档模式: ✅
- 5个核心章节: 全部存在
- 结构: 所有5个步骤结构一致
- 格式: 正确的标题层级
最佳实践遵循: 8/10 ✅
✅ 验证检查清单: 存在且具体
✅ 文档中包含示例: 6个示例
✅ 快速参考: 存在
⚠️ 错误处理: 有限(示例中仅包含正常流程)
反模式检测: 1个检测到 ⚠️
✅ 无关键词堆砌(15个自然关键词)
✅ 无单体文件(1465行但包含references/目录)
✅ 结构一致
✅ 具体验证准则
✅ 示例完整(无占位符)
⚠️ 错误场景: 仅记录正常流程
✅ 依赖项: 已明确记录
✅ 未过度设计
代码质量: 不适用(无脚本)
质量评分: 4/5(良好)
主要问题: 错误处理文档有限
建议: 添加错误场景示例及恢复指导Usability Review: skill-researcher
==================================
Real-World Scenario Test: ✅
- Scenario: Research GitHub API integration patterns
- Result: SUCCESS - Found 5 relevant sources, synthesized findings
- Experience: Smooth, operations clearly explained
- Time: 45 minutes (expected 60 min range)
Navigation/Findability: 9/10 ✅
- Information easy to find
- 5 operations clearly separated
- Quick Reference table very helpful
- Minor: Could use table of contents for long doc
Instruction Clarity: 9/10 ✅
- Steps clear and actionable
- Process well-explained
- Examples demonstrate concepts
- Minor: Web search query formulation could be clearer
Effectiveness: 10/10 ✅
- Achieved purpose: Found patterns and synthesized
- Delivered value: Comprehensive research in 45 min
- Would use again: Yes, very helpful
Learning Curve: 8/10 ✅
- Time to understand: 10 minutes
- Time to use effectively: 15 minutes
- Reasonable for complexity
- First-time user: Some concepts need explanation (credibility scoring)
Error Handling: N/A (no errors encountered)
User Satisfaction: 9/10 ✅
- Would use again: Yes
- Would recommend: Yes
- Overall experience: Very positive
Usability Score: 5/5 (Excellent)
Minor Improvement: Add brief explanation of credibility scoring concept可用性评审: skill-researcher
==================================
实际场景测试: ✅
- 场景: 研究GitHub API集成模式
- 结果: 成功 - 找到5个相关来源,完成成果整合
- 体验: 流畅,操作说明清晰
- 时间: 45分钟(预期60分钟范围内)
导航/可查找性: 9/10 ✅
- 信息易于查找
- 5个操作清晰分离
- 快速参考表格非常实用
- 小问题: 长文档可添加目录
说明清晰度: 9/10 ✅
- 步骤清晰且可操作
- 流程解释充分
- 示例演示核心概念
- 小问题: 网页搜索查询构建说明可更清晰
有效性: 10/10 ✅
- 实现目标: 找到模式并完成整合
- 交付价值: 45分钟内完成全面研究
- 会再次使用: 是,非常实用
学习曲线: 8/10 ✅
- 理解时间: 10分钟
- 熟练使用时间: 15分钟
- 与复杂度匹配
- 首次用户: 部分概念需要解释(可信度评分)
错误处理: 不适用(未遇到错误)
用户满意度: 9/10 ✅
- 会再次使用: 是
- 会推荐: 是
- 整体体验: 非常积极
可用性评分: 5/5(优秀)
小改进建议: 添加可信度评分概念的简要说明dependenciesdependenciesIntegration Review: development-workflow
========================================
Dependency Documentation: 10/10 ✅
- Required Skills: None (workflow is standalone)
- Component Skills: 5 clearly documented (skill-researcher, planning-architect, task-development, prompt-builder, todo-management)
- Optional Skills: 3 complementary skills mentioned (review-multi, skill-updater, testing-validator)
- YAML Field: Not used (not required, skills referenced in content)
Data Flow Clarity: 10/10 ✅ (Workflow Skill)
- Data flow diagram present (skill → output → next skill)
- Inputs/outputs for each step documented
- Users understand how artifacts flow
- Example:
Component Integration: 10/10 ✅
- Integration method documented for each step (Guided Execution)
- Integration examples provided
- Clear explanation of how skills work together
- Process for using each component skill detailed
Cross-Reference Validation: ✅
- Internal links valid (references/ files exist and reachable)
- External skill references correct (all 5 component skills exist)
- Complementary skills mentioned appropriately
Composition Pattern: 10/10 ✅ (Workflow Skill)
- Pattern: Sequential Pipeline (with one optional step)
- Correctly implemented (Step 1 → 2 → [3 optional] → 4 → 5)
- Orchestration details provided
- Clear flow diagram
Integration Score: 5/5 (Excellent)
Notes: Exemplary integration documentation for workflow skilldependenciesdependencies集成评审: development-workflow
========================================
依赖项文档: 10/10 ✅
- 所需技能: 无(工作流为独立技能)
- 组件技能: 5个已明确记录(skill-researcher、planning-architect、task-development、prompt-builder、todo-management)
- 可选技能: 3个互补技能已提及(review-multi、skill-updater、testing-validator)
- YAML字段: 未使用(非必须,技能在内容中引用)
数据流清晰度: 10/10 ✅(工作流技能)
- 提供数据流图(技能 → 输出 → 下一个技能)
- 每个步骤的输入/输出已记录
- 用户理解工件如何流转
- 示例:
组件集成: 10/10 ✅
- 每个步骤的集成方法已记录(引导式执行)
- 提供集成示例
- 清晰解释技能如何协同工作
- 详细说明每个组件技能的使用流程
交叉引用验证: ✅
- 内部链接有效(references/目录下文件存在且可访问)
- 外部技能引用正确(所有5个组件技能存在)
- 互补技能提及恰当
组合模式: 10/10 ✅(工作流技能)
- 模式: 顺序流水线(含1个可选步骤)
- 实现正确(步骤1 → 2 → [3可选] → 4 → 5)
- 提供编排细节
- 清晰的流程图
集成评分: 5/5(优秀)
备注: 工作流技能的集成文档堪称典范Comprehensive Review Report: skill-researcher
=============================================
OVERALL SCORE: 4.6/5.0 - GRADE A
STATUS: ✅ PRODUCTION READY
Dimension Scores:
- Structure: 5/5 (Excellent) - Perfect file organization
- Content: 5/5 (Excellent) - Comprehensive, clear documentation
- Quality: 4/5 (Good) - High quality, minor error handling gaps
- Usability: 5/5 (Excellent) - Easy to use, highly effective
- Integration: 4/5 (Good) - Well-documented dependencies
Production Readiness: READY - High quality, deploy with confidence
Recommendations (Priority Order):
1. [Medium] Add error handling examples for web search failures
2. [Low] Consider adding table of contents for long SKILL.md
Strengths:
- Excellent structure and organization
- Comprehensive coverage of 5 research operations
- Strong usability with clear instructions
- Good examples throughout
Overall: Exemplary skill, production-ready quality全面评审报告: skill-researcher
=============================================
综合评分: 4.6/5.0 - 等级 A
状态: ✅ 生产就绪
各维度评分:
- 结构: 5/5(优秀) - 文件组织完美
- 内容: 5/5(优秀) - 文档全面、清晰
- 质量: 4/5(良好) - 高质量,错误处理存在微小空白
- 可用性: 5/5(优秀) - 易用性强,高效
- 集成: 4/5(良好) - 依赖项文档完善
生产就绪性: 可上线 - 高质量,可放心部署
建议(按优先级):
1. [中] 添加网页搜索失败的错误处理示例
2. [低] 考虑为长SKILL.md添加目录
优势:
- 结构和组织优秀
- 全面覆盖5个研究操作
- 可用性强,说明清晰
- 文档中包含优质示例
整体评价: 堪称典范的技能,具备生产就绪质量python3 scripts/validate-structure.py /path/to/skill$ python3 scripts/validate-structure.py .claude/skills/my-skill
Fast Check Report
=================
Skill: my-skill
❌ FAIL - Critical Issues Found
Critical Issues:
1. YAML frontmatter: Invalid syntax (line 3: unexpected character)
2. Naming convention: File "MyGuide.md" should be "my-guide.md"
Quick Fixes:
1. Fix YAML: Remove trailing comma on line 3
2. Rename file: mv references/MyGuide.md references/my-guide.md
Run full validation after fixes: python3 scripts/validate-structure.py .claude/skills/my-skillpython3 scripts/validate-structure.py /path/to/skill$ python3 scripts/validate-structure.py .claude/skills/my-skill
快速检查报告
=================
技能: my-skill
❌ 失败 - 发现关键问题
关键问题:
1. YAML frontmatter: 语法无效(第3行:意外字符)
2. 命名规范: 文件"MyGuide.md"应命名为"my-guide.md"
快速修复方案:
1. 修复YAML: 删除第3行的尾随逗号
2. 重命名文件: mv references/MyGuide.md references/my-guide.md
修复后重新运行完整验证: python3 scripts/validate-structure.py .claude/skills/my-skillCustom Review: Content + Examples
- Operations: Content Review only
- Thoroughness: Thorough
- Focus: Example quality and completeness
- Time: 30 minutesCustom Review: Structure + Quality (Fast)
- Operations: Structure + Quality
- Thoroughness: Quick
- Focus: Pattern compliance, anti-patterns
- Time: 15-20 minutesCustom Review: Integration Deep Dive
- Operations: Integration Review only
- Thoroughness: Thorough
- Focus: Data flow, composition patterns
- Time: 30 minutes自定义评审: 内容 + 示例
- 操作: 仅内容评审
- 细致度: 细致
- 聚焦: 示例质量与完整性
- 时间: 30分钟自定义评审: 结构 + 质量(快速)
- 操作: 结构 + 质量
- 细致度: 快速
- 聚焦: 模式合规性、反模式
- 时间: 15-20分钟自定义评审: 集成深度分析
- 操作: 仅集成评审
- 细致度: 细致
- 聚焦: 数据流、组合模式
- 时间: 30分钟validate-structure.pyvalidate-structure.pyreferences/scoring-rubric.mdreferences/scoring-rubric.md| Operation | Focus | Automation | Time | Key Output |
|---|---|---|---|---|
| Structure | YAML, files, naming, organization | 95% | 5-10m | Structure score, compliance report |
| Content | Completeness, clarity, examples | 40% | 15-30m | Content score, section assessment |
| Quality | Patterns, best practices, anti-patterns | 50% | 20-40m | Quality score, pattern compliance |
| Usability | Ease of use, effectiveness | 10% | 30-60m | Usability score, scenario test results |
| Integration | Dependencies, data flow, composition | 30% | 15-25m | Integration score, dependency validation |
| 操作 | 聚焦领域 | 自动化程度 | 时间 | 核心输出 |
|---|---|---|---|---|
| 结构评审 | YAML、文件、命名、组织 | 95% | 5-10m | 结构评分、合规报告 |
| 内容评审 | 完整性、清晰度、示例 | 40% | 15-30m | 内容评分、章节评估 |
| 质量评审 | 模式、最佳实践、反模式 | 50% | 20-40m | 质量评分、模式合规性 |
| 可用性评审 | 易用性、有效性 | 10% | 30-60m | 可用性评分、场景测试结果 |
| 集成评审 | 依赖项、数据流、组合 | 30% | 15-25m | 集成评分、依赖项验证 |
| Score | Level | Meaning | Action |
|---|---|---|---|
| 5 | Excellent | Exceeds standards | Exemplary - use as example |
| 4 | Good | Meets standards | Production ready - standard quality |
| 3 | Acceptable | Minor improvements | Usable - note improvements |
| 2 | Needs Work | Notable issues | Not ready - significant improvements |
| 1 | Poor | Significant problems | Not viable - extensive rework |
| 评分 | 等级 | 含义 | 行动 |
|---|---|---|---|
| 5 | 优秀 | 超出标准 | 堪称典范 - 作为示例 |
| 4 | 良好 | 符合标准 | 生产就绪 - 标准质量 |
| 3 | 合格 | 需小幅改进 | 可使用 - 记录改进点 |
| 2 | 需改进 | 存在明显问题 | 暂不就绪 - 需要显著改进 |
| 1 | 较差 | 存在严重问题 | 不可用 - 需要全面重构 |
| Overall Score | Grade | Status | Decision |
|---|---|---|---|
| 4.5-5.0 | A | ✅ Production Ready | Ship it - high quality |
| 4.0-4.4 | B+ | ✅ Ready (minor improvements) | Ship - note improvements for next iteration |
| 3.5-3.9 | B- | ⚠️ Needs Improvements | Hold - fix issues first |
| 2.5-3.4 | C | ❌ Not Ready | Don't ship - substantial work needed |
| 1.5-2.4 | D | ❌ Not Ready | Don't ship - significant rework |
| 1.0-1.4 | F | ❌ Not Ready | Don't ship - major issues |
| 综合评分 | 等级 | 状态 | 决策 |
|---|---|---|---|
| 4.5-5.0 | A | ✅ 生产就绪 | 发布 - 高质量 |
| 4.0-4.4 | B+ | ✅ 小幅改进后可上线 | 发布 - 记录改进点用于下一迭代 |
| 3.5-3.9 | B- | ⚠️ 需改进 | 暂缓 - 先修复问题 |
| 2.5-3.4 | C | ❌ 暂不就绪 | 不发布 - 需要大量优化 |
| 1.5-2.4 | D | ❌ 暂不就绪 | 不发布 - 需要显著重构 |
| 1.0-1.4 | F | ❌ 暂不就绪 | 不发布 - 存在重大问题 |
| Mode | Time | Use Case | Coverage |
|---|---|---|---|
| Fast Check | 5-10m | During development, quick validation | Structure only (automated) |
| Custom | Variable | Targeted review, specific concerns | Selected dimensions |
| Comprehensive | 1.5-2.5h | Pre-production, full assessment | All 5 dimensions + report |
| 模式 | 时间 | 适用场景 | 覆盖范围 |
|---|---|---|---|
| 快速检查 | 5-10m | 开发过程中、快速验证 | 仅结构(自动化) |
| 自定义评审 | 可变 | 针对性评审、特定关注点 | 选定维度 |
| 全面评审 | 1.5-2.5h | 上线前、全面评估 | 所有5个维度 + 报告 |
undefinedundefinedundefinedundefinedOverall = (Structure × 0.20) + (Content × 0.25) + (Quality × 0.25) +
(Usability × 0.15) + (Integration × 0.15)综合评分 = (结构 × 0.20) + (内容 × 0.25) + (质量 × 0.25) +
(可用性 × 0.15) + (集成 × 0.15)references/structure-review-guide.mdreferences/content-review-guide.mdreferences/quality-review-guide.mdreferences/usability-review-guide.mdreferences/integration-review-guide.mdreferences/scoring-rubric.mdreferences/review-report-template.mdreferences/structure-review-guide.mdreferences/content-review-guide.mdreferences/quality-review-guide.mdreferences/usability-review-guide.mdreferences/integration-review-guide.mdreferences/scoring-rubric.mdreferences/review-report-template.md