用途:为开源项目撰写或改进简洁、面向读者的 README.md,适用于新建 README、重写 README、补充安装与用法示例等场景。目标是让潜在用户了解项目做什么、为何有用、如何快速跑通。
主要能力与工作流:先检查现有 README、清单文件、公开 API、示例、测试、发布元数据和许可证;再确定目标读者、项目解决的问题、最短可用流程以及影响采用的关键限制或取舍;只保留项目真正需要的章节,典型顺序为项目名、直接介绍、关键能力、安装、最小示例、进阶流程或设计说明、贡献指南、许可证。优先写最小可运行示例,使用仓库中真实的命令、包名、API 和配置,仅在能回答后续常见问题时才补充专门示例。对可变动的说法、命令、链接、支持版本和示例进行核实,条件允许时运行最小安全示例或相关检查,并报告仍未验证的内容。
写作风格:先说明有用性再讲安装,用具体结果和用例代替“强大、健壮、易用”等空泛表述;快速从背景过渡到安装和可运行示例;示例前说明其演示内容,从常见情况推进到有意义的变体;把安全警告、运维注意事项和取舍放在其限定的示例或说法旁边;必要时用设计说明帮助读者信任重要实现选择;结构规模与项目匹配,演示项目可能只需背景、取舍、部署和链接,成熟库可能需要兼容性、多个示例和设计理由。使用简洁直接的美式英语和对话式技术语气,保留作者术语与声音,避免营销语言、填充内容和仅为惯例而加的章节。绝不编造功能、命令、支持、性能或成熟度;若无法从现有证据确定项目目的或受众,应提出一个聚焦问题。仅审计请求只报告按优先级排列的发现而不编辑;创建、重写或修复请求则更新 README 并保留无关文件。
限制:资料未提供具体安装命令、价格、平台支持或性能数据;实际使用需结合具体项目仓库内容。