一个项目刚写完时，每个目录的用途都很清楚。过了几个星期，再看到同样的文件名，却可能需要重新猜测当时的安排。
项目说明文档可以替过去的自己保留这些线索。
开头先说明用途
第一段回答一个简单的问题：这个项目帮助谁完成什么事情。比起列出所有使用的工具，一句具体的用途更容易建立方向。
例如，下面是一段虚构项目的介绍：
这是一个本地阅读清单，用来记录想读的文章、阅读状态和一句简短笔记。
让第一次运行有迹可循
运行说明需要包含前提、步骤和预期结果。命令本身只是其中一部分，还应说明在哪里执行，以及成功后会看到什么。
| 说明项 | 要回答的问题 |
|---|---|
| 环境 | 需要哪些工具和版本？ |
| 准备 | 哪些配置要先填写？ |
| 启动 | 从哪个目录执行什么命令？ |
| 验证 | 怎样确认关键功能可以使用？ |
| 数据 | 内容保存在哪里，怎样备份？ |
把容易忘记的选择写下来
有些决定在代码里不明显：为什么先使用本地文件，为什么暂时没有账号系统，某个看似重复的步骤是为了解决什么问题。
不用给每一行实现都配解释。只记录那些下次看到时，可能会忍不住问“为什么这样做”的地方。
留下一个继续入口
最后写一两项明确的后续工作。范围小一些，让重新打开项目的人能够顺着说明找到第一步。
好的说明不必很长。它只需要在记忆变模糊之后，仍然能把人带回正确的位置。
本文为测试文章，文中的项目场景为虚构示例。