一份真正有用的 README,应该先回答什么

先让读者知道项目解决什么问题,再告诉他怎样完成第一次运行。

2026.11.04写作与笔记短篇笔记
文档与工具的抽象插图

从具体场景开始

不要先列出全部技术栈。先写出谁会在什么情况下使用它,以及使用后能得到什么。例如,一个整理照片的脚本,首先应该说明输入目录和输出结果,而不是解释它使用了哪几个库。

把第一次成功缩短

给出一条最小运行路径:准备什么、执行什么、成功后看到什么。示例中的文件名、路径与实际项目保持一致。需要配置的值用清楚的名字标出来,把可选功能放在第一次运行之后。

把边界写在相关位置

如果工具只处理某些格式,直接在输入说明旁写明。常见错误最好附带识别方法和修复动作。每次修改行为时,同步检查示例是否仍然有效,避免说明和程序各自发展。

继续读