
维护说明 · 分项说明
概念说明
维护说明是对对象在长期使用中如何保持可用所作的书面交代,核心是把正常状态与需要处理的偏差之间的界限写清楚,让日常照看有统一依据。
判断方法
别把步骤写得细当成可执行。判断一条维护说明能否照做,先单独抽出动作的前提:对象应处于什么状态、上一步结果要满足什么;再假设跳过前提直接执行,看是否无法判断何时可做、做到什么程度算完成。4HTV。前提和完成标志都写得可观察,这条才可用。
适用边界
并非同一类对象的说明都能通用。它只在对象能被唯一指认、且对象标识与说明所写对象对得上时适用;多台混放、标识缺失或配置已改动时,先确认是哪一台、哪一版,不能凭说明直接执行。说明未覆盖的后续判断,也不因写了维护步骤而自动成立。



读者评论
我们验收前都会把该看的材料列清楚,免得现场翻箱倒柜
补充个经历:验收时把对方也拉进来一起测,后面少吵很多
小团队压根没有写文档的习惯,从哪开始改比较好
说实在的,写再多流程不如双方坐下来把话说透一次
把所有变更记在同一张表里,回头翻起来方便很多