主题
[模块名] · 操作手册
文档版本:0.01 | 最近核对日期:[日期]
文档控制
| 项目 | 内容 |
|---|---|
| 模块名称 | |
| 关联需求分析 | [链接] |
| 关联测试与验收 | [链接] |
| 适用角色 | |
| 编写/核对人 | |
| 前置环境 | 系统地址、浏览器、账号申请方式(不写真实密码) |
1. 菜单与权限
| 角色 | 菜单路径 | 可查看范围 | 可执行操作 | 不可执行操作 |
|---|---|---|---|---|
2. 使用前准备
- 登录和权限前提:
- 必要的组织、项目或基础数据:
- 附件、导入文件或其他格式要求:
3. 业务操作
3.1 [任务名称]
- 从
[菜单路径]进入页面; - 填写或选择
[字段/条件]; - 点击
[操作],确认系统提示; - 检查状态、列表、详情或通知结果。
成功标准:
3.2 [审批/退回/撤回等任务]
按角色、前置状态、操作、系统结果和下一步分别说明,覆盖正常和退回/异常路径。
4. 字段与提示
| 页面/字段 | 填写说明 | 是否必填 | 格式/范围 | 错误提示与处理 |
|---|---|---|---|---|
5. 常见问题与异常
| 现象/提示 | 常见原因 | 用户处理 | 仍失败时提供给运维的信息 |
|---|---|---|---|
不得在手册中写入真实账号密码、令牌或个人敏感信息;需要授权时引用私有仓库 README 的管理流程。