外观
星图磐轴志 · 说明文档库
把可以标准化的操作写成可执行的步骤。每篇文档按“适用范围 → 准备工作 → 操作步骤 → 验证方法 → 常见问题 → 回滚与注意事项”组织,按顺序执行即可。
先读适用范围,再按步骤执行。每一步都给出验证方法,出错时可以回到上一节,而不是从头再来。
每篇文档都从准备条件写起,不假设你熟悉上一节之外的内容。
操作完成后有明确的检查命令与预期结果,避免“看起来成功了”。
涉及配置修改的文档都写明回滚方式。先想好怎么退,再动手。