数据源可能暂停更新:最后一次成功检查是 UTC,距今已超过 3 小时。页面上的时间仍按官方原帖计算,但最近几小时的新公告可能还没收录——以官方账号为准。
README 与快速上手文档重写
分类:文档 · 更新于 2026-09-21 · 适用工具:两者
适合 README 明显过时、缺少安装步骤,或者新人接手时总要靠口头传授才能跑起来的项目。消耗量级:中——需要通读入口文件和配置,但不涉及大范围代码修改。
提示词全文
请阅读项目的入口文件、依赖配置和现有 README,重写一份 README.md,结构包含:项目一句话简介、环境要求、安装步骤、如何本地运行、如何跑测试、目录结构简述、常见问题。每个命令都要是你从项目配置里实际确认过存在的,不要凭经验编造命令。写完后模拟一个从零开始的新人,按你写的步骤在心里过一遍,指出哪一步信息不够、需要补充。只改 README 和相关文档文件,不要动业务代码。
使用建议
- 让它先列大纲给你确认,避免返工重写整篇
- 明确要求“命令必须是从配置文件里核实过的”,防止编造不存在的 npm script
- 如果项目有多种启动方式(本地/Docker),要求分开写清楚,别混在一起