这些错误几乎每个新手都踩过,逐条对照自查。
1. 开头没有一句话简介
修正:标题下加一句「它解决什么问题」。
2. 安装命令漏了包管理器
修正:给出 npm / pnpm / yarn 至少一种完整命令。
3. 用法复制跑不起来
修正:用最小配置,确保装完依赖即出结果。
4. 没有 License
修正:加 MIT + LICENSE 文件,否则别人不敢用。
5. 特性写成功能列表而非收益
修正:每条讲清楚对用户的价值。
6. 全英文但受众是中文用户
修正:面向国内就写中文,或做双语。
7. 没有贡献方式
修正:写清怎么提 PR / Issue。
8. 大段无结构文字
修正:用标题、列表、代码块分段。
用工具生成能自动规避 1/2/3/4/7/8 这类结构问题,剩下的靠你补内容。
立即使用 AI README 生成器 →