交接一份文件,也交接它的来处
文件名、用途、摘要和检查方式放在一起,接收者就不必靠猜测判断它是否完整。
文件之外,还需要一小段说明
收到一个压缩包时,最先冒出来的问题通常很朴素:它对应哪个任务,里面什么最重要,哪个文件才是当前结果。把这些信息写在顶层说明里,会比期待接收者按文件名推断更可靠。
需要保留旧版本时,可以明确标注它的用途。旧材料有时有恢复或对照价值,但不应该因为恰好排在目录最前面,就被误认为当前入口。
给内容留一个可核对的指纹
摘要可以用于比较交接前后的字节是否相同。它能够帮助发现传输或保存过程中的变化,但不能单独证明文件来自可信的人,也不能替代安全的传递方式。
sha256sum report.txt > report.txt.sha256
sha256sum --check report.txt.sha256- 说明文件对应的任务和时间。
- 指出推荐先打开的入口。
- 给重要文件保存摘要。
- 注明是否还需要额外的配置或权限。
从接收者的位置走一遍
整理完之后,可以把交接目录放到一个新的位置,再按自己的说明试着打开。原来依赖绝对路径、临时目录或个人终端环境的步骤,往往会在这时暴露出来。
一份好的交接,不必把所有过程都重演一遍。它需要给出清楚的起点、足够的上下文和一个可以核对结果的方法,让另一个人能够继续往前走。
静花手记 · 日常整理查看文章归档 →