Operator journal 01

A small journal entry on keeping operational notes readable enough to become future documentation.

发布于
2023年3月8日
阅读
1 分钟
标签
operator, journal, documentation

很多运维记录一开始只是写给当下的自己看的,但只要结构稍微认真一点,它们就能慢慢长成未来的文档。

写给未来的自己

一份好的操作记录,应该在半年后回看时仍然能快速恢复当时的判断背景。

文档也应该有版式

就算是很技术化的笔记,如果标题、时间和步骤之间的节奏清楚,阅读成本也会低很多。

BL

Written by

Bojin Li

Writes about software, systems, and design.

评论

0 条

留个言

匿名、轻量、可审核。