谈谈操作日志

谈谈操作日志

最近手上有好几项工作，都感觉是需要写日志的，随便聊聊吧。

哪些工作要写日志

• 以后可能还需要重复操作，流程相对复杂的工作。

  • 我配置了一个 openwrt 的路由器，刷入 openwrt 的流程其实挺繁琐的，我自己查阅了很多资料才解决。此外，有些资源其实在网上已经很难获取（例如原版的 clash 内核，对应的预编译固件）我对这些资源做了留档，并在日志中记录了留档的位置。

  • 计软智学院赛事部，一些自动化脚本的操作文档。之前一直是手工处理，通过加人来减少单人的工作负担。我写好了 Python 脚本。由于又涉及到和 SEUOJ 数据库的交互，实际上走完一遍流程的耗时不算短（10min）左右，这种事情是间隔几个月来一次，需要写日志来告诉自己怎么做，避免多次阅读源代码。

  这些日志应该在第一次操作时就写好，写的越早，节省的时间越多。此外，留档的话题是之后的事，我可能还会写一篇文章来谈留档。

• 需要让他人接手的一的周期很长的工作。

  • SEUOJ 的运维日志，包括各个东西的配置放在哪里的，配置了哪些自动化任务，服务是怎么被启动的等等。事实上，一台状态不明的但是能用的服务器比一台全新的服务器更加可怕。这些元数据的丢失使得另外的人在接手时出现误操作的概率大大提升。我自己接手 SEUOJ 的初期就出了很多问题，现在已经半年了，摸清楚机子的脾性后胆子也就大了起来，开始维护起运维日志，减少下一任上手的门槛。
  • 赛事部操作脚本，老东西总有毕业的一天，也很难保证接下来的小东西有足够的技术能力从头搞一份，我这些代码大概率会变成祖传代码，写点稍微详细的操作步骤有利于后面的人接手。

实际上这两种日志还有细微的差别。操作日志和博客又有一定差别。具体的，我认为精细程度上，博客>给别人看的日志>给自己参考的日志。

虽然这么说，给自己参考的日志其实给到一个和自己水平差不多的人，他也能看懂的，比如何山直接拿我路由器刷机日志去自己操作了一遍，也没出什么大的幺蛾子。

openwrt 刷机日志

包含内容

• 最重要的几篇参考资料，github 仓库地址等。
• 资源留档的路径。
• 大体操作流程，精细到和我同水平时可以构建出完整流程，识别出关键步骤。
• 可能的误操作后的还原流程，踩的坑点。
• 一些其它相关的配置方式（获取这些信息相对容易，但是记录下来可以显著减少时间）

留档

• 一些花了很大力气才找到的资源（主要是二进制文件）

SEUOJ 运维日志

包含内容

• 机器的密码。
• 服务的配置路径，主路径，资源路径，日志路径。
• 对服务做细微调整时，留下的操作日志（供后来者要做调整时参考）。
• 常规操作时（调整数据库，查询数据）的记录以及 SQL 语句，方便后续继续使用。
• 额外写了一篇 HTTPS 证书维护的日志，性质和 openwrt 的操作日志差不多。

闲聊

• 有些东西是方便以后自己再做一些东西。
• 有些是为了后来人接手（比如 HTTPS 证书的维护，我已经配置好了自动的东西，但是还是要写，毕竟后面的人不知道我干了啥）

赛事部脚本操作日志

包含内容

• 写明哪些量是需要每次操作时更改的，哪些函数可能需要更改。
• 写明运行脚本的环境，和所需数据，指明获取所需数据的方法，和上游工作流对接。
• 写明脚本运行前后应该进行哪些人工操作完成整个工作流。

闲聊

• 后续小登不知道技术实力如何（但是有 AI 之后可以预见的是很难再找到一个和我同年龄时同水平的运维）。
• 所以做前辈的要铺好路，少走弯路，降低门槛，让小登能打怪升级升上来。