# 一个整理日志的小命令

**URL:** <https://buildx.do/t/%E4%B8%80%E4%B8%AA%E6%95%B4%E7%90%86%E6%97%A5%E5%BF%97%E7%9A%84%E5%B0%8F%E5%91%BD%E4%BB%A4/131>\
**Category:** 筑码工坊\
**Tags:** 作品展示\
**Created:** [2026 年10 月 5 日 17:19 UTC](https://buildx.do/t/%E4%B8%80%E4%B8%AA%E6%95%B4%E7%90%86%E6%97%A5%E5%BF%97%E7%9A%84%E5%B0%8F%E5%91%BD%E4%BB%A4/131 "2026-10-05T17:19:00Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![zhouqi](https://buildx.do/letter_avatar_proxy/v4/letter/z/5f9b8f/32.png) [@zhouqi](https://buildx.do/u/zhouqi)\
**Post date:** [2026 年10 月 5 日 17:19 UTC](https://buildx.do/t/%E4%B8%80%E4%B8%AA%E6%95%B4%E7%90%86%E6%97%A5%E5%BF%97%E7%9A%84%E5%B0%8F%E5%91%BD%E4%BB%A4/131/1 "2026-10-05T17:19:00Z")

</div>

「一个整理日志的小命令」。

按请求编号把散落的行收在一起。自己值班用。还很粗糙，但比手搜快。

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

展示的是一个能用的小东西，不是计划。写清楚它解决哪一件具体的事，输入是什么，输出是什么，什么情况下不要用。边界没做完就直说。主路径通了就可以给别人试，不必等所有边角都齐。

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

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

补充记录。展示写给会用的人，不写给围观的人。第一段说明它解决的一件事。第二段写输入和输出，最好有一条最小例子。第三段写不要在什么情况下用，例如数据太大、需要外网、还没做的边界。主路径通了就可以给别人试，边角列在后面，不要等全部做完。错误提示写下一件事，而不只写代号。仓库里放怎么跑、怎么停。停不掉的小工具，不该算做完。

操作顺序。1. 用一段话说明它解决的一件事。2. 给出最小输入和对应输出。3. 写明不要在什么情况下用。4. 写怎么启动、怎么停、失败时看哪。5. 主路径通了就让别人试，没做的边界列在后面。6. 错误提示写成下一件事，而不是只给代号。7. 自己按说明从干净环境走一遍。走不通就改说明。展示的标准不是功能多，而是另一个人能在不问作者的情况下用起来并停掉。

---

<div class="post-metadata">

**Author:** ![liweiqi](https://buildx.do/letter_avatar_proxy/v4/letter/l/ccd318/32.png) [@liweiqi](https://buildx.do/u/liweiqi)\
**Post date:** [2026 年10 月 5 日 18:30 UTC](https://buildx.do/t/%E4%B8%80%E4%B8%AA%E6%95%B4%E7%90%86%E6%97%A5%E5%BF%97%E7%9A%84%E5%B0%8F%E5%91%BD%E4%BB%A4/131/2 "2026-10-05T18:30:00Z")

</div>

按请求编号把日志收拢，值班时很值。输出再短一点，复制到聊天里也方便。
