你可能会说
给这个项目补一份 README，说明怎么跑、怎么改。
记录项目怎么用、怎么改的文字说明——README、注释、API 说明。
记录项目怎么用、怎么改的文字说明——README、注释、API 说明。写好了别人（和未来的你）才能接手。
生活类比
像电器的使用说明书——没有它，再好的电器别人也不会用。
🎮 动手试试
关于「文档」，以下哪个描述最准确？
你可以这样告诉 AI
给这个项目写一份 README：包含项目介绍、本地运行步骤、目录结构说明和 API 接口列表。
注释写在代码里解释某一段逻辑，文档独立于代码描述项目怎么用和怎么改。
项目要交接或开源
让 AI 帮你写 README、API 文档、使用说明，别人（包括未来的你）才能快速上手。
和 AI 协作时
对 AI 说「帮我给这个项目写一份 README，包含安装步骤、使用示例和 API 说明。」
代码本身就很清晰
命名好、结构清晰的代码自带说明效果，过度注释反而让代码更难读。
个人临时脚本
一次性用的临时脚本不需要文档，写文档的时间可能比写脚本还长。
记录项目怎么用、怎么改的文字说明——README、注释、API 说明。写好了别人（和未来的你）才能接
像电器的使用说明书——没有它，再好的电器别人也不会用。
和 AI 沟通时提到「补一下文档」，就是把使用方法写清楚。