97 lines
2.9 KiB
Markdown
97 lines
2.9 KiB
Markdown
|
<!-- gitea-wiki-mirror:start -->
|
||
|
|
generated: true (请先修改 Gitea Wiki，禁止直接编辑本文件)
|
||
|
|
wiki_page: Audience-Document-Template
|
||
|
|
wiki_url: http://ilaer.eicp.net:8418/opc/dev_harness/wiki/Audience-Document-Template.-
|
||
|
|
wiki_revision: 7a8f38df566fe639094497c9692e0559c9c080e6
|
||
|
|
synchronized_at: 2026-08-10T06:23:41Z
|
||
|
|
<!-- gitea-wiki-mirror:end -->
|
||
|
|
|
||
|
|
# 岗位文档模板
|
||
|
|
|
||
|
|
> 使用说明：复制本模板创建具体岗位文档，删除说明性文字并填写真实内容。没有明确受众时不要创建文档；不得保留“待填写”后直接交付。
|
||
|
|
|
||
|
|
## 文档信息
|
||
|
|
|
||
|
|
| 字段 | 内容 |
|
||
|
|
|---|---|
|
||
|
|
| 文档名称 | |
|
||
|
|
| 适用对象 | 最终用户 / 管理员 / 运维 / 客服 / 集成人员 / 验收人员 / 其他 |
|
||
|
|
| 适用版本 | |
|
||
|
|
| 最后验证日期 | YYYY-MM-DD |
|
||
|
|
| 负责人 | |
|
||
|
|
| 可见范围 | 内部 / 指定客户 / 公开 |
|
||
|
|
| 相关产品或模块 | |
|
||
|
|
|
||
|
|
## 目的与适用范围
|
||
|
|
|
||
|
|
说明读者完成什么工作，以及本文包含和不包含什么。用岗位语言描述结果，不复制内部需求分析。
|
||
|
|
|
||
|
|
## 前置条件
|
||
|
|
|
||
|
|
- 所需权限：
|
||
|
|
- 所需环境或设备：
|
||
|
|
- 已完成的准备：
|
||
|
|
- 需要提前获得的信息：
|
||
|
|
|
||
|
|
不得在这里填写真实密码、令牌、个人数据或生产数据。
|
||
|
|
|
||
|
|
## 操作步骤
|
||
|
|
|
||
|
|
### 任务一：<明确的操作目标>
|
||
|
|
|
||
|
|
1. <执行动作>
|
||
|
|
2. <执行动作>
|
||
|
|
3. <执行动作>
|
||
|
|
|
||
|
|
**预期结果**：<读者可以观察到的成功结果>
|
||
|
|
|
||
|
|
**失败时**：<先检查什么；何时停止并联系支持>
|
||
|
|
|
||
|
|
每个独立任务重复以上结构。命令和界面名称应与适用版本一致；危险或不可逆操作必须在执行前给出醒目警告、影响和回退条件。
|
||
|
|
|
||
|
|
## 常见错误与恢复
|
||
|
|
|
||
|
|
| 现象或错误信息 | 可能原因 | 处理步骤 | 何时升级 |
|
||
|
|
|---|---|---|---|
|
||
|
|
| | | | |
|
||
|
|
|
||
|
|
只记录经过确认的原因和恢复方法。不要让外部读者执行内部调试、绕过权限或可能扩大损失的操作。
|
||
|
|
|
||
|
|
## 安全与权限
|
||
|
|
|
||
|
|
- 本岗位允许执行的操作：
|
||
|
|
- 明确禁止或需要审批的操作：
|
||
|
|
- 敏感信息处理规则：
|
||
|
|
- 数据、日志和截图脱敏要求：
|
||
|
|
- 删除、发布、迁移或其他高风险操作的确认要求：
|
||
|
|
|
||
|
|
## 已知限制
|
||
|
|
|
||
|
|
- 支持的环境和版本：
|
||
|
|
- 当前不支持的场景：
|
||
|
|
- 兼容性限制：
|
||
|
|
- 未验证的环境或步骤：
|
||
|
|
|
||
|
|
## 支持与升级处理
|
||
|
|
|
||
|
|
- 支持渠道：
|
||
|
|
- 服务时间或响应约定：
|
||
|
|
- 联系支持前需要收集的信息：
|
||
|
|
- 不得提交的信息：
|
||
|
|
- 需要升级到下一岗位或负责人的条件：
|
||
|
|
|
||
|
|
## 版本记录
|
||
|
|
|
||
|
|
| 日期 | 适用版本 | 变更内容 | 验证人 |
|
||
|
|
|---|---|---|---|
|
||
|
|
| | | | |
|
||
|
|
|
||
|
|
## 交付前检查
|
||
|
|
|
||
|
|
- [ ] 目标岗位能够理解术语和步骤。
|
||
|
|
- [ ] 前置条件、步骤与预期结果一一对应。
|
||
|
|
- [ ] 关键流程已按目标岗位视角验证。
|
||
|
|
- [ ] 常见错误、恢复方法和升级条件清楚。
|
||
|
|
- [ ] 没有内部工单、内部地址、敏感数据或无关源码细节。
|
||
|
|
- [ ] 适用版本、最后验证日期、负责人和可见范围已填写。
|