运行手册网站使用场景
- 值班事件响应快速找到严重性、首次响应和升级指引。
- 服务归属文档说明范围、依赖关系和面向客户的服务影响。
- 部署恢复工作流将发布、回滚和密钥轮换流程集中在一起。
- 运维手册设计为快速重复使用组织密集的技术指引。
运维参考亮点
- 服务上下文归属、版本、审核日期和生产级别集中呈现。
- 告警响应表阈值将严重性、含义和首次操作关联起来。
- 流程区块命令和运维注意事项共享一条易读的操作序列。
- 事件时间线五个响应步骤组织起最初的 30 分钟。
从服务上下文到事件交接
1 / 5
身份验证服务运行手册设计
这份 OpenDesign 官方网站示例将 Northwind 身份服务运行手册呈现为统一的运维参考。界面标题为“auth-service”，其后列出归属、版本、审核日期和“TIER 0 · PRODUCTION-CRITICAL”状态。开篇在读者看到告警或命令之前，先明确服务所承担的责任。
服务摘要列出了面向 Web、移动端和公共 API 的会话令牌签发、验证与撤销。它还标明了密码存储、TOTP/WebAuthn 注册和审计日志写入器。这样一来，页面便可用于快速了解情况：响应人员可以在选择流程之前，看到哪些面向客户和与安全相关的责任属于该服务。
支持的运维任务
该设计支持多个相关任务，而没有将它们拆分到不同页面中。页面顺序从服务范围进入依赖关系，然后依次是告警、流程、值班覆盖和事件响应。这样的顺序减少了孤立解读告警的需要：读者先了解服务负责什么，再了解某一部分受损时如何响应。
依赖列表对 Postgres、Redis、KMS、SES 和 Pager 重复使用名称加状态的模式。其中四项标记为健康，而 SES · transactional 标记为降级。右对齐的状态有助于快速浏览，但它们只是示例设计的快照，并不代表已展示实时健康检查。
| 章节 | 可见内容 | 读者用途 |
|---|---|---|
| 服务摘要 | 归属、范围、会话行为和依赖关系 | 明确影响范围和系统边界 |
| 你可能会被叫醒的告警 | 阈值、严重性、含义和首次响应 | 选择初步调查路径 |
| 常见流程 | 部署、回滚、密钥轮换和积压处理命令 | 遵循命名明确的运维工作流 |
| 事件响应 | 前 30 分钟的五项编号操作 | 协调确认、缓解和交接 |
从告警到流程
告警部分采用四列表格，分别呈现告警、严重性、含义和首次响应。例如，“auth.login_5xx_rate greater than 1%”与“SEV-1”、客户无法登录的说明，以及检查 Postgres 和 Redis 面板的指引相配对。明确的阈值为响应人员提供触发条件，说明文字则提供解读；示例数值若用于真实运行手册，仍需要经过验证的监控来源。
流程部分从紧凑的行切换为较大的区块，每个区块包含标题、使用说明、解释性句子和命令面板。“Deploy a new version”说明流程采用蓝绿发布，并在切换流量前等待连续两次健康检查。可见的流量序列“10% / 50% / 100%”传达了分阶段发布；较大的区块占用更多纵向空间，以便更安全地阅读命令。
命令与约束
流程区块让操作与注意事项彼此相邻。回滚标明在部署后的错误率超过 1% 时使用，而签名密钥轮换写着“Schedule with security; never solo.”。审计日志流程则明确关联到积压告警。这些配对展示了一项有用的信息设计选择：命令不会被当作独立即可执行的内容呈现，周围的条件定义了它何时属于工作流。
事件序列与能力边界
最后的事件响应部分将最初的 30 分钟转换为五张编号卡片。序列从五分钟内确认开始，打开专用事件频道，要求每十分钟发布一次状态快照，优先进行缓解，最后交接或结束响应。编号使预期顺序清晰可见；双栏排列让前四项操作保持紧凑，而第五张卡片仅横跨自身内容。
这是一个仅用于展示设计的网站示例。隔离环境中的截图页面直观呈现了命令、状态、名称以及“rolled back to v4.7.2 in 38 s”等示例结果，但它并未证明这些命令能够执行、这些服务已经连接，或所显示的运维结果经过测量。进行改编时，应保留已记录的指引与经验证的运行时数据之间的区别。
确认告警
设计从 /ack 和五分钟响应窗口开始，明确了第一项协调义务。
打开事件频道
第二张卡片列出了用于创建专用响应空间的服务名称和短标题模式。
发布状态快照
第三张卡片将客户影响、当前认知和下一步检查压缩为一条可重复发布的更新。
缓解并交接
最后两张卡片优先处理回滚或安全升级，然后定义交接和关闭。
如何在 OpenDesign 中创建服务运行手册网站设计
定义服务边界
从服务名称、归属、版本、审核日期、生产级别、面向客户的责任和依赖状态开始。摘要应足够具体，以区分影响范围与实现细节。
建议提示词为 Northwind 身份平台中的 auth-service 创建一个深色、桌面优先的服务运行手册网站。使用宽幅居中的页面，包含服务页眉、级别徽章、双栏摘要与依赖面板、告警表格、操作流程区块、值班覆盖信息，以及五张编号的事件响应卡片。仅使用示例数据；不要暗示存在实时监控、命令执行、已连接服务或经测量的结果。
将告警连接到操作
使用包含告警名称、严重性、含义和首次响应的表格。保留诸如 auth.login_5xx_rate 大于 1% 这类阈值与后续操作之间的关系，并在数值经过验证之前将其标注为示例性内容。
提升流程可读性
在命令面板之前，为每个流程提供条件、注意事项或时间说明。检查蓝绿发布、回滚、签名密钥轮换和审计日志积压清理仍然是彼此独立的工作流，而不是混在同一个代码块中。
检查事件顺序
将五张响应卡片作为按时间排列的序列进行检查：确认、打开频道、发布状态快照、缓解，然后交接或结束响应。确认卡片在较小屏幕上堆叠时布局仍然易读。
导出并获取分享链接
导出完成的设计稿，然后在 OpenDesign 中使用「Share」功能获取分享链接。在单独的浏览器窗口中打开链接，确认目标版本及其资源均可正常访问后，再将链接发送给他人。
