README 撰写助手

要解决的问题

很多项目的 README 不是“没写”，而是“写了但读不下去”：功能介绍像散文，安装步骤缺依赖，示例命令一跑就报错。结果就是，协作者搞不清项目边界，用户在上手第一步就流失。readme-writer 只聚焦一件事：把 README 变成读者能在 30 秒内看懂“这是什么、怎么装、怎么用”的入口文档。

技能如何工作

• 收集信息：先确认项目名称、一句话简介、主要功能、技术栈和目标用户；关键信息缺失时，一次问一个，避免一次性抛出大段问卷。
• 选择结构：以 references/template.md 中的标准章节为起点，根据项目类型按需增删，而不是套用同一套模板。
• 撰写内容：优先写好安装与使用章节；命令和代码示例保证完整、可直接复制运行，不留 xxx、your-key 之类的占位符。
• 打磨检查：复核占位符是否替换、链接是否有效、安装步骤是否遗漏依赖，再考虑目录或徽章等辅助元素。

适用边界

适合为新项目创建 README、改写或完善已有 README，以及补齐安装、使用、贡献指南等标准章节。不适用于与软件项目无关的普通写作、纯粹的代码解释，或 API 文档生成；这些场景需要不同的信息密度与组织结构。