教学软件使用文档编写指南

教学软件使用文档是为了帮助用户理解该教育软件的目标、作用、意义和使用方法而必备的文档资料，应随程序一起发至用户。文档的编写可分为功能简介和使用说明书两部分。其内容按以下要求编写：

    一、功能简介

    1. 软件名称及其版本号

    2. 开发者

    开发者姓名、单位、联系地址、邮政编码等。

    3. 载体

    载体形式（磁盘／磁带／光盘及其规格等）；载体卷数。

    4. 教育目标

    预定达到的教育目标，包括过程性目标（子目标），应尽可能详尽。

    5. 适用范围及对象

    适用学生年龄、年级、认知能力、水平层次等。

    6. 硬件支撑环境要求

    运行该软件所需要的计算机种类、型号、外设配置、内存最低容量等。

    7. 软件支撑环境要求

    运行该软件所需要的软件支持。例如操作系统的类型、版本号、汉字输入系统的名称及版本等。

    8. 功能特点

    该软件的各项功能及子功能，使用该软件于教学活动的主要特点。例如，学生学习进程管理、练习题目随机产生，判断反馈有针对性等等。

    9. 应用建议

    对该软件用于教学活动时使用方法的建议。如：主要用于示教；主要用于个人操练；主要用于观看后组织课堂讨论等。

    10. 参考资料

    列出本软件应分发给用户的文档资料名。指出使用软件时可使用与参阅的其他参考资料和来源（如教科书与练习册）等。

    二、使用说明书

    软件的使用方法要从下述五个方面加以说明。

    1. 安装与初始化方法

    描述把软件安装到计算机上的会话过程和初始化过程。必要时用屏幕图示来表达。

    2. 启动方法

    启动命令及其参数；启动的会话过程。

    3. 操作

    用户所能使用的各功能项的操作命令、操作方法与操作过程。

人机会话格式：软件如何等待用户输入；输入数据的格式（语法规则、长度、顺序、标点、缺省等信息的约定）、所用各种键的意义与作用等。

退出、中断、返回上级功能项（或主功能项）的方法。

    以上应分别给以必要的实例解释。

    4. 错误处理

说明各种可能产生的错误、产生错误的原因及对用户处理这些错误的建议。

5. 输出信息

    列出所有输出信息及相应的解释。