「对内逻辑文档 + 对外操作文档」

软件说明书 = 内部逻辑设计文档（研发自己看）
用户手册 = 对外用户操作文档（客户看）
培训材料 = 教学培训课件 / 讲义（培训上课用）

 

培训材料

定位：给实施 / 运维 / 讲师 / 内部新人 / 客户管理员培训用

• 介于两者之间
• 比用户手册多一点业务背景、场景流程、批量操作、配置讲解；
• 比软件说明书少底层技术细节
• 用来做岗前培训、客户落地培训、新人入职培训

用户手册

定位：对外 / 终端用户看
就是你要写的用户操作文档

• 写给使用软件的普通客户、操作人员
• 内容：安装步骤、页面操作、功能怎么用、常见问题、操作流程，只讲怎么做，不讲底层原理

 

软件说明书

定位：对内 / 研发侧看

就是你说的内部逻辑文档

• 写给开发、测试、产品、运维看
• 内容：业务逻辑、模块架构、接口说明、数据流程、设计原理、异常逻辑、底层规则
• 不写给普通用户，用户看不懂也不需要看