# 输出写成人话

**URL:** <https://buildx.do/t/%E8%BE%93%E5%87%BA%E5%86%99%E6%88%90%E4%BA%BA%E8%AF%9D/218>\
**Category:** 筑码工坊\
**Tags:** 脚本开发\
**Created:** [2026 年10 月 7 日 14:16 UTC](https://buildx.do/t/%E8%BE%93%E5%87%BA%E5%86%99%E6%88%90%E4%BA%BA%E8%AF%9D/218 "2026-10-07T14:16:00Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![caiwen](https://buildx.do/letter_avatar_proxy/v4/letter/c/bc79bd/32.png) [@caiwen](https://buildx.do/u/caiwen)\
**Post date:** [2026 年10 月 7 日 14:16 UTC](https://buildx.do/t/%E8%BE%93%E5%87%BA%E5%86%99%E6%88%90%E4%BA%BA%E8%AF%9D/218/1 "2026-10-07T14:16:00Z")

</div>

「输出写成人话」。

不要只吐一串代号。写下一步可以做什么。

给后来的人看，所以写能照着做的步骤，不写感受。每一步写期望看到什么。看不到，就停在这一步，不要继续往下猜。步骤结束以后，用干净环境再做一次。自己的机器上能过，只能说明自己的机器上能过。

脚本要敢再跑一次：空参数直接退出，做完的步骤跳过，失败用非零退出码。真正修改之前先打印将要做什么。密码和家目录路径不要写死。日志追加到固定文件，定时跑失败才有人能看见。文件开头写清参数和一条例子。

收尾只留三行在仓库里：现象，改了哪一处，怎样确认。聊天记录会沉，仓库还在。三行对不上，就还没完，先不要告诉别人已经好了。对得上，别人才能在不找作者的情况下把同一件事再做一遍。

复查「输出写成人话」时按这四步，不靠感觉。用改之前的同一组输入再走一遍，结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名，确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。

补充记录。脚本按能再跑一次来写。空参数直接退出并说明缺什么，不能让空值把范围变宽。已经完成的步骤跳过。失败用非零退出码，否则调用方会继续。真正修改之前先打印将要做什么，确认再执行。密码放环境或单独文件，路径当参数，不写家目录。日志追加到固定文件，定时任务失败才看得见。文件开头写参数和一条例子。没有这几行，下周的自己也看不懂，别人更不敢跑。

操作顺序。1. 文件开头写参数和一条例子。2. 空参数立刻退出，并说明缺什么。3. 执行修改前先打印将要做什么。4. 已完成的步骤跳过，保证可以再跑。5. 失败使用非零退出码。6. 密码来自环境或单独文件，路径来自参数。7. 日志追加到固定位置。8. 自己按说明从空目录跑通，再故意缺一个参数看它会不会把范围改宽。会改宽，就不能给定时任务用。定时跑的失败如果只打印在当时的屏幕上，等于没有记录。

---

<div class="post-metadata">

**Author:** ![chenmiao](https://buildx.do/letter_avatar_proxy/v4/letter/c/d2c977/32.png) [@chenmiao](https://buildx.do/u/chenmiao)\
**Post date:** [2026 年10 月 7 日 15:14 UTC](https://buildx.do/t/%E8%BE%93%E5%87%BA%E5%86%99%E6%88%90%E4%BA%BA%E8%AF%9D/218/2 "2026-10-07T15:14:00Z")

</div>

失败时写出下一步可以做什么。只吐代号，还得再查一次表。
