Create Accurate READMEs From Project Code 今日发布

是什么

这是一套从项目代码中自动生成准确 README 文档的技能。通过检查代码仓库中的实际文件（而非依赖猜测），生成包含安装、使用、API 等标准章节的项目说明文档。

核心能力

• 检查 Node、Python、Go、Rust、Java 项目的清单文件，提取元数据、依赖项、脚本和入口点信息
• 自动构建标题徽章、简介、安装、使用、API、贡献指南、许可证等标准章节
• 从源码注释和文档化的帮助输出中提取 API 和命令用法
• 在项目根目录或指定路径写入或更新 README.md
• 对无法确认的信息标记为 TODO，而不编造事实
• 根据语言类型选择对应的文档模板和命令模式

适用场景

• 为新仓库创建 README：从现有的清单文件、入口点、脚本和许可证数据生成第一版说明文档
• 更新过时的项目说明：对比现有 README 与当前代码仓库，替换已失效的命令或依赖说明
• 改善贡献者入门体验：为公开协作项目生成清晰的安装、使用、API、贡献和许可证章节

使用方式

安装后发送「为这个仓库生成 README」，AI 助手将检查项目文件并生成对应章节。

依赖与限制

• 帮助命令不一定安全，因为项目初始化可能在处理 --help 标志之前就已运行
• 输出质量依赖准确的清单文件、源码注释、脚本和许可证文件
• 徽章图片需要网络访问，构建状态在未验证 CI 配置前仅为占位符

安全说明

已通过 Skillstore 安全审计（2026-07-22），确认为纯提示词技能，无凭据访问、无命令注入风险。