Trupeer Blog

ServiceNow 实施文档:需要记录什么以及如何记录

ServiceNow 实施文档:需要记录什么以及如何记录

总结

目录

使用 AI 创建令人惊艳的产品视频和文档

免费开始使用

下个月已安排进行一次 ServiceNow 升级。平台团队需要了解哪些业务规则、流程和客户端脚本可能会受到影响;审计人员希望获得谁有权批准变更的证据;同时一位新的管理员刚刚加入。每个人都会去查文档,结果却发现上线时的设计文档、一个已经与当前界面不匹配的截图文件夹,以及大量只存在于某位顾问脑中的知识。

ServiceNow 实施文档可以避免这种情况。它会记录系统构建了什么、为什么这样配置、如何配置,以及人们如何使用它,从而让平台能够被安全地升级、审计和扩展。本指南将说明 ServiceNow 实施文档应包含哪些内容,如何在不依赖手动截图的情况下记录工作流,如何为审计捕获配置,如何在每个阶段记录相应内容,以及如何在 ServiceNow 的常规版本发布中保持文档持续更新。

什么是 ServiceNow 实施文档?

ServiceNow 实施文档是一组用于解释 ServiceNow 实施情况的记录:需求与流程设计、实例搭建、配置与定制、集成、数据与 CMDB 的决策、测试、发布,以及指导代理、员工和管理员如何使用并运行平台的各类指南。它适用于 ITSM,也适用于其他 ServiceNow 工作流,例如 HR 服务交付或客户服务。

其他企业平台同样适用相同原则;请参阅 如何记录复杂的企业软件流程,覆盖 SAP、ServiceNow 和 Salesforce。

为什么 ServiceNow 实施文档很重要?

  • 升级更安全。 ServiceNow 每年发布两次新版本,而有文档记录的定制内容能明确需要测试什么。

  • 审计更轻松。 审计人员希望看到配置、访问控制以及变更审批的证据。

  • 管理员交接风险更低。 每个设置背后的原因不会随着构建者离开而消失。

  • 变更更高效。 团队在修改业务规则之前不必先进行逆向工程。

  • 采用效果更好。 拥有清晰指南的代理和员工会按设计方式使用平台。

ServiceNow 实施文档应包含哪些内容?

Eleven parts of ServiceNow implementation documentation

文档

涵盖内容

需求与流程设计

ITSM 流程,例如事件、请求、问题和变更,以及这些流程背后的决策

实例环境

开发、测试和生产实例,以及变更如何在它们之间流转

配置日志

表、字段、表单、业务规则、客户端脚本、UI 策略、流程和通知,并说明其用途与负责人

访问与安全

角色、组、访问控制以及审批权限

服务目录

目录项、变量、工作流和履约组

集成

已连接的系统、数据流、凭据归属以及错误处理

CMDB 与数据

CMDB 范围、数据源、归属以及数据质量规则

发布与变更记录

每次发布包含了什么,以及如何获得审批

测试

测试脚本、结果与自动化测试

用户与代理指南

面向代理、审批人和员工的分步指南与视频

管理员运行手册

日常任务,例如用户管理、克隆下发以及升级准备

如何在不依赖手动截图的情况下记录 ServiceNow 工作流?

Manual screenshots vs recording-first ServiceNow documentation

手动截图是记录 ServiceNow 的最慢方式。每一步都意味着捕获、裁剪、粘贴和标注;而每次 UI 变更都会让截图迅速过时。采用“先录制”的方式更快、更易维护:

  1. 只录制一次工作流, 在你的实例中执行该流程,并在讲解每一步的同时进行录制,使用 Trupeer 的 AI 屏幕录制工具。

  2. 自动生成指南。 Trupeer 会将录制内容转换为分步指南,并附上已捕获的截图与旁白视频。

  3. 编辑并补充上下文, 例如业务规则、审批标准以及接下来会发生什么。

  4. 发布到人们会查看的地方, 放在你的知识库或门户中。

  5. 通过编辑更新, 当标签或步骤发生变化时,无需重新录制。

这同样适用于代理工作流、目录请求、审批以及管理员任务。若是专门针对知识文章,请参阅 ServiceNow 知识文章最佳实践。

如何为审计记录 ServiceNow 配置?

How to document ServiceNow configurations for audit

审计人员和平台治理团队需要了解:系统配置了什么、谁可以更改,以及变更是如何获得审批的。要为审计记录 ServiceNow 配置:

  • 为每次定制保留配置日志,记录其用途、负责人、日期以及满足的需求。

  • 记录关键配置的演示流程, 例如审批规则、访问控制和变更工作流,并展示它们在实例中的工作方式。

  • 按组记录角色与访问权限,并说明特权角色的业务理由。

  • 将每次变更都关联到其审批, 通过你的变更与发布记录实现。

  • 为文档做版本管理, 这样你可以在任意时间点展示配置的样子;参阅 SOP 版本控制。

  • 定期复核, 尤其在审计前以及升级之后。

每个实施阶段应该记录哪些内容?

What to document in each ServiceNow implementation phase

阶段

需要记录的内容

发现

当前流程、痛点、需求,以及平台必须处理的业务量

设计

流程设计、数据模型、目录设计、安全模型和集成设计,并说明原因

构建

配置日志、脚本与流程、集成细节,以及对复杂逻辑的录制演示

测试

测试脚本、结果、缺陷与签字确认

部署

发布内容、部署步骤、数据加载与回滚计划

超关怀与运行

问题与修复、常见问题、更新后的指南,以及交接给运行团队

如需测试证据,请参阅 UAT 文档清单。

如何一步步创建 ServiceNow 实施文档?

Six steps to create ServiceNow implementation documentation

步骤 1:确定文档标准

在构建开始之前,决定你需要哪些文档、每种文档的模板、它们将存放在哪里,以及由谁负责。

步骤 2:在设计过程中记录决策

记录设计决策时,写明考虑过哪些选项以及为何选择其中一个。未来管理员最需要的就是这些推理依据。

步骤 3:在构建时记录配置

在创建每一项定制时就把它加入配置日志,而不是等到项目结束。

步骤 4:记录流程与配置的演示

录制管理员讲解复杂流程与规则,以及关键用户执行代理与员工任务的过程;然后将录制内容转换为指南和视频。

Recording a ServiceNow workflow walkthrough in Trupeer AI

步骤 5:为每类受众构建指南

为代理、审批人、员工和管理员分别创建独立指南。代理的培训与文档应当相辅相成;参阅 ServiceNow 培训视频最佳实践。

ServiceNow guides for agents, approvers, employees and admins

步骤 6:交接时明确负责人和复核日期

在项目收尾阶段,为每份文档指定负责人,并约定每次发布如何更新文档。

如何在升级过程中保持 ServiceNow 文档的最新状态?

Keeping ServiceNow documentation current across upgrades
  • 将文档复核纳入每次升级, 同时结合跳过记录与回归测试。

  • 将文档更新与变更记录绑定, 确保没有任何变更在文档更新完成前就关闭。

  • 通过编辑脚本来更新指南,而不是重新录制;参阅 如何在不重新录制的情况下更新培训视频。

  • 为已移除的配置停用文档。

  • 每次发布后用当前 UI 检查指南,尤其是面向员工和代理。

这种方法也适用于其他 ITSM 平台吗?

可以。无论你使用 ServiceNow、Atomicwork、Freshservice 或其他 ITSM 工具,相同原则都适用:记录决策与配置,用录制演示替代手动截图,为每份文档指定负责人,并在每次变更时更新文档。只有术语和界面会有所不同。想要对照查看,请参阅 ITSM 平台文档对比。

ServiceNow 实施文档清单

  • 需求与流程设计已记录关键决策背后的原因。

  • 已记录实例环境与推广流程。

  • 配置日志覆盖每一项定制,并包含用途与负责人。

  • 已记录并说明角色、组与访问控制的合理性。

  • 已记录目录项、集成以及 CMDB 的决策。

  • 已存储并建立关联测试证据与发布记录。

  • 已发布代理、审批人、员工和管理员指南。

  • 每份文档都有负责人和复核日期。

  • 每次升级与变更后都会复核文档。

常见的 ServiceNow 文档错误

  • 只记录“做了什么”,不记录“为什么”, 这样没人知道这项定制是否仍然重要。

  • 依赖手动截图,而每次发布都会导致截图过时。

  • 把文档工作拖到上线之后才做。

  • 把文档放在项目文件夹里,交接后没人会再去看。

  • 忽视终端用户与代理指南, 会影响采用效果;参阅我们的 ServiceNow 用户采用策略。

  • 升级后从不更新文档。

使用 Trupeer 创建 ServiceNow 实施文档

ServiceNow guide generated from a recording in Trupeer AI

Trupeer 会将你对 ServiceNow 实例的录制内容转换为分步指南和视频,因此配置演示、代理工作流以及员工操作要点都能在不依赖手动截图的情况下完成记录,并在每次升级后保持最新。查看 Trupeer 的 IT 知识库与 SOP 平台 或 立即使用 Trupeer 免费开始。

常见问题

什么是 ServiceNow 实施文档?

它是一组用于解释 ServiceNow 实施情况的记录:需求、流程设计、实例搭建、配置、访问、目录、集成、CMDB、测试、发布,以及面向代理、员工和管理员的指南。

ServiceNow 文档应包含哪些内容?

需求与流程设计、实例环境、配置日志、角色与访问、目录项、集成、CMDB 与数据决策、发布与测试记录、用户与代理指南,以及管理员运行手册。

如何在不使用截图的情况下记录 ServiceNow 工作流?

在你的实例中录制一次并进行讲解,然后使用像 Trupeer 这样的工具将录制内容转换为分步指南(包含已捕获的截图与视频);最后通过编辑更新,而不是重新录制。

如何为审计记录 ServiceNow 配置?

为每次定制保留包含用途、负责人和日期的配置日志;记录关键配置的演示流程;记录角色与访问权限;将变更关联到审批,并为文档做版本管理。

ServiceNow 文档应多久更新一次?

只要有任何会影响文档的变更就要更新,并且每次升级都要更新,因为 ServiceNow 每年发布两次新版本。

谁应该负责维护 ServiceNow 文档?

平台负责人或 ServiceNow 管理员团队应负责维护文档库,并为每个流程领域与指南指定具体负责人。

管理员文档与用户指南有什么区别?

管理员文档解释平台如何构建与维护。用户指南解释代理、审批人和员工如何完成各自的任务。两者都属于 ServiceNow 实施文档的一部分。

这种方法适用于 Atomicwork 或 Freshservice 吗?

可以。任何 ITSM 平台都遵循相同原则;只是术语和界面会有所不同。

常见问题

什么是 ServiceNow 实施文档?

ServiceNow 文档应包含哪些内容?

如何在不截图的情况下记录 ServiceNow 工作流?

如何为审计记录 ServiceNow 配置?

ServiceNow 文档应多久更新一次?

谁应该负责维护 ServiceNow 文档?

管理员文档和用户指南有什么区别?

这种方法适用于 Atomicwork 或 Freshservice 吗?

需要视频剪辑师、翻译和编剧吗?

免费试用 Trupeer

预约演示

需要视频剪辑师、翻译和编剧吗?

免费试用 Trupeer

预约演示

需要视频剪辑师、翻译和编剧吗?

免费试用 Trupeer

预约演示

了解工作如何发生。
将其带入你的下一次转型。

开始免费试用

预约演示

了解工作如何发生。
将其带入你的下一次转型。

开始免费试用

预约演示