错误提示改成像说话

「错误提示改成像说话」。

少写代码,多写人能看懂的下一件事。用了一周,询问少了。

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

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

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

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

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

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

5 个赞

提示里写下一件事,而不只写错误代号。询问会少一截。

3 个赞