很多人在写项目README时,喜欢堆砌一堆漂亮的形容词,什么“简洁明了”“开箱即用”“企业级”,恨不得把所有好词都用上。但你猜怎么着?读者看到这些东西的第一反应,往往是直接跳过——因为这些词根本没告诉他,你的项目到底能解决什么具体问题、在什么场景下真正能用。说白了,形容词越多,可信度越低。
那么,该怎么写?从砍掉废话开始。
先删掉所有不指向具体行为的形容词
打开README.md,逐行扫描,看到“高性能”“轻量级”“现代化”“优雅”“强大”这类只能表态、不能说明任何操作细节的修饰语,直接删掉。保留的唯一标准是:这个词删掉后,用户是否还能判断下一步该做什么?如果删了不影响执行,那它就没有存在的价值。
用动词短语替代名词化套话
把“提供完善的错误处理机制”改成“运行时遇到缺失配置会直接报错,并提示改哪行.env文件”。把“具备良好的可扩展性”改成“想加微信登录?复制粘贴3行代码到auth.ts,再填一个WECHAT_APP_ID环境变量”。把“遵循最佳实践”改成“默认禁用eval()、自动转义HTML输出、JWT密钥强制从环境变量读取”。这样用户一看就知道下一步怎么干,而不是只得到一个模糊的承诺。
用真实命令和截图锚定可信度
快速开始区块里,第一行必须是可复制粘贴的真实命令,比如:curl -sL https://raw.githubusercontent.com/xxx/cli/main/install.sh | sh。紧接其后放一张终端截图,截图中必须包含命令回车后的前两行输出,比如显示“Installing v2.4.1…”和“Done. Run mytool --help to start”,截图不能打码路径和版本号。如果项目依赖特定系统版本,必须写成“仅支持 Node.js 18.17+(因使用了stream.Readable.from({objectMode: true}))”,而不是“兼容主流Node版本”。不写清楚版本边界,用户可能在Node 16上卡死在install阶段,然后直接放弃。
