用途
source-command-polish 是一个用于“打磨项目展示”的技能。当用户要求运行迁移后的 source command polish 时使用。其目标是让项目变得专业、友好且文档完善。
主要能力
该技能覆盖以下范围：
README
- 清晰的项目描述（是什么、为什么、怎么做）
- 安装说明（经过测试）
- 快速开始示例（可直接复制粘贴）
- 关键特性（3-5 个要点）
- API 概览
- 完整文档链接
- 徽章（构建状态、覆盖率、版本、许可证）
- 贡献指南链接
- 许可证
文档
- API 参考（所有公开函数）
- 使用示例（常见场景）
- 教程（分步指南）
- 架构概览
- 故障排除指南
- FAQ
- 迁移指南（如适用）
代码注释
- 公开 API 的 JSDoc
- 复杂逻辑解释（说明“为什么”而非“是什么”）
- 记录非显而易见的决策
- 在有用处添加注释示例
打包（package.json）
- 准确的描述
- 相关关键词（10-15 个）
- 仓库 URL
- 主页 URL
- 缺陷跟踪 URL
- 作者信息
- 许可证
- 指定 engines
- files 字段（仅发布必要文件）
GitHub 元数据
- 主题/标签（10-20 个相关标签）
- 描述（简洁、可搜索）
- 网站 URL
- 社交预览图（如适用）
变更日志
- 更新 CHANGELOG.md
- 清晰的版本历史
- 突出破坏性变更
- 迁移说明
贡献
- CONTRIBUTING.md
- 行为准则
- 开发环境搭建
- 测试指南
- PR 流程
使用方式
该技能以命令模板形式提供，命令为“Polish Project”。执行流程包括：
- 审计现有内容与缺失内容
- 更新过时内容
- 创建缺失的文档
- 测试所有代码示例
- 验证所有链接有效
- 确保各文档之间保持一致
质量检查
- README 在 5 分钟阅读内解释清楚项目
- 新用户可在 10 分钟内上手
- 所有示例经过测试且可用
- 无失效链接
- 关键词便于搜索
- 专业的展示
- 对初学者友好
报告
输出报告说明：新增/更新了什么、覆盖率如何提升。
适用场景
适用于需要将项目（尤其是开源项目）的展示材料、文档、打包配置和元数据整理到专业水准的场景。
限制
资料中未提供关于收费、价格、平台支持范围或具体效果保证的信息。