用途:为软件项目或开源仓库撰写或改进 README,回答“这是什么、为什么值得用、如何立刻运行”三个问题,并在其后补充细节,让新用户能快速得到可用结果。
主要能力:生成完整的 README.md 结构,包含项目名、一句话定位、徽章占位行、Why(问题与价值)、Features(关键功能要点)、Quickstart(安装与最小可运行示例,含预期结果)、Usage(常见用法与短代码示例,深度内容改为链接)、Installation(较完整安装与依赖说明)、Contributing(贡献方式与链接)、License(许可证行)。
使用方式:输入项目名称与一句话用途、目标用户、安装与基本用法、关键功能或差异点;可选提供语言、许可证、文档与演示链接、贡献政策、项目状态(alpha/beta/stable)。若未提供,技能会先询问这些必需输入。缺少的信息不宜编造,应明确标注或省略。
适用场景:新项目首次写 README、现有 README 结构混乱或缺少快速上手、需要为开源仓库整理标准分节时。
质量要求与限制:开头必须先给一句话定位,不把功能埋在徽章或背景故事之下;快速上手须可复制运行、步骤完整;Why 应具体诚实,不用泛泛赞美;结构可扫读,深层细节用链接而非全部内联;安装、用法、贡献与许可证应覆盖或有意识地省略;不夸大,需反映真实项目状态;不应跳过许可证,因为它决定他人能否合法使用。具体输出格式与命令示例需以实际项目内容为准,资料未提供其他更细的实现细节或收费信息。