嵌入式专业项目文档模板

1、wat f密级组号湖南科技职业学院软件学院项目文档项 口题口 系部专业学生姓名指导老师20xx年xx月项目文档编写模板文档信息文档名称：项目文档编写模板负责人:xxx文档版本编号：tech-spec-docu密级：普通文档版本日期：2008-9-21起草人:起草日期：2008-9-21复审人:复审日期：任务分配表来自from日期电话/传真xxx2008-9-211232模块名称负责人截止日期完成日期版本记录版本编号版本日期修改者说明1.02008-9-21xxx草案目录%1 软件需求说明书（软件计划书，确定软件的总体功能）11.1 弓i言11.2 业务流程整体说明（使用业务语言）11.3 特殊

2、说明11.4 原始资料1%1 需求分析报告32.1 引言32.2 任务概述32.3 功能需求32.4 性能需求32.5 运行环境描述42.6 其他需求4%1 软件设计书（详细设计说明书，建立软件结构）53.1 引言53.2 硕件结构设计53.3 软件结构设计53.4 数据结构设计53.5 硬件描述53.5.1 模块 153.5.2 模块 263.5.3 模块 n63.6 程序描述63.6.1 模块 173.6.2 模块 273.6.3 模块 n8%1 程序设计说明书91. 引言92. 系统电路图错误！未定义书签。3. 各功能核心代码和界面说明91. 功能一92. 功能二93. 功能 n9%1

3、软件测试说明书10引言10计划10测试项目说明10测试计划执行情况10评价1（）%1 用户手册12弓丨吕12系统功能介绍12运行环境说明12运行前的准备12输入输出说明和操作说明12安全与保密13常见问题的处理13附录：安装与初始化（必须提供）13-软件需求说明书（软件计划书，确定软件的总体功能）1.1引言 编写m的（阐明编写需求说明书的目的） 项冃背景（应包括：项冃的委托单位、开发单位和主管部门;该软件系统与其他系统的关系。）1.2业务流程整体说明（使用业务语言）总体流程图总体流程图的文字说明子流程图1-子流程图1 的文字说明子流程图1中组成部分1详细描述子流程图2子流程图2 的文字说明子流

4、程图1中组成部分2详细描述子流程图2中组成部分1详细描述子流程图2中组成部分2详细描述业务人员首先应对业务有一个总体流程图，同时辅以文字说明。如果总的流程图的各个 组成部分述可以细分的话，应继续用了流程图的形式对它的各组成部分进行说明并辅以文字 说明，直到流程图的各个组成部分的业务步骤不可再分为止。例如代理录入订单，在详细描 述中应包括以下内容：订单的详细信息；代理编号（长度要求，需耍代理手工选择）；订单 号（长度要求、需要代理手工输入）1.3特殊说明需要特殊说明的一些问题，例如本系统与现有具他软件系统的关系等。1.4原始资料bookmark41 资料收集：应收集所有与业务需求相关的原始资料，

5、为后续工作（如：需求分析等） 做准备。bookmark41 原有业务流程概述：对原有业务流程进行说明（采取流程图方式）bookmark41 原始单据、原始报表等：以列表的方式列出原始资料的名称，而h要与原冇业务流 程概述的内容相对照，并将实际的原始资料附在业务分析书的后面。原始资料名称对应于原冇业务流程概述的哪一部分内容需求分析报告2.1引言bookmark41 编写冃的针对软件需求说明书提出的需求做进一步分析，详细定义用户耍求，为软件设计提 供必要的指导。2.2任务概述目标叙述该项软件开发的意图、应用目标、作用范围以及该软件的背景资料。解释被开 发软件与其他冇关软件z间的关系。如果木软件是一

6、个独立的软件，而全部内容 自含，则说明这一点。如果定义的产品是一个更人系统的一个组成部分，则应说明 本产品与该系统中其他各组成部分之间的关系。bookmark41 假定与约束列出木软件开发工作的假定与约束，例如经费限制、开发期限等等。2.3功能需求bookmark41 功能划分对于流程图中的各个功能用树状结构自顶向下进行细化。并对最底层的功能进行编 码，给出功能标识符。 功能描述对最底层的功能所要完成的功能进行详细描述，填入下表中:功能名称功能标识符功能详细描述2.4性能需求bookmark41 时间要求例如响应时间、更新处理时间、数据转换和传送时间等等。bookmark41 适应性（在操作方

7、式、运行环境、与其他软件的接口等发生变化时，所具有的适应 能力。）2.5运行环境描述bookmark41 硬件设备bookmark41 支持软件（操作系统、数据库、其他软件系统如：lotus notes等）bookmark41 接口（硬件接口、软件接口）bookmark41 控制（说明控制该软件的运行的方法）bookmark41 用户界面（反映业务流程的用户界面）2.6其他需求bookmark41 如可用性、安全保密、可维护性、可跨平台性等。（分高、中、低定性详细描述）三软件设计书（详细设计说明书，建立软件结构）3.1引言bookmark41 编写冃的软件设计说明卩是为程序设计进行指导的文档，

8、主耍功能是建立软件的结构，详细 说明每个功能的上下功能模块和输入输出接口。3.2硬件结构设计bookmark41 描述硕件功能结构图3.3软件结构设计bookmark41 软件功能结构图3.4数据结构设计bookmark41 数据结构（e-r图）bookmark41 数据结构为程序的关系用-张炬阵图说明各个数据库表与各模块的对应关系。模块1模块2数据库表1七数据库表n3.5硬件描述（逐个模块给出以下的说明：）3.5.1模块1 功能说明该程序应具冇的功能，并填写下表:系统：系统（项目）名称设计人：xxx模块:模块名称日期:20xx-xx-xx上层调用模块可调用的下层模块输入输出硬件模块说明：局部

9、注释项bookmark41 接口说明木程序所隶属的上一层模块及隶属于木系统的下一层模块。bookmark41 限制条件bookmark41 测试要点（给出测试模块的主要测试要求。）bookmark41 尚未解决的问题3.5.2模块2（内容同上）3.5.3模块n（内容同上）3.6程序描述（逐个模块给出以下的说明：）3.6.1模块1 功能说明该程序应貝有的功能，并填写下表:系统：系统（项目）名称设计人：xxx模块:模块名称日期:20xx-xx-xx上层调用模块可调用的下层模块输入输出处理过程说明：局部注释项bookmark41 算法本程序所选用的算法，具体的计算公式和计算步骤。bookmark41

10、 流程逻辑对当前模块的实现用状态图來进行描述或者川流程图的形式辅以必要的说明來表 示本程序的逻辑流程。bookmark41 接口说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数 赋值和调用方式，说明与木程序直接关联的数据库。bookmark41 限制条件bookmark41 测试耍点（给出测试模块的主耍测试耍求。）bookmark41 尚未解决的问题3.6.2模块2（内容同上）3.6.3模块n（内容同上）四程序设计说明书4.1引言 编写冃的说明本软件的各功能模块实现技巧及核心代码4.2各功能核心代码和界面说明4.2.1功能一实现技巧。 功能界血 核心代码4.2.2功能二

11、实现技巧。 功能界面 核心代码4.2.3功能n实现技巧。功能界面 核心代码五软件测试说明书5.1引言bookmark41 编写冃的指导软件测试并给出结果表以填写测试结果5.2计划bookmark41 测试方案（说明确定测试方法和选取测试用例的原则如：用八界而测试、功能流程 测试、性能测试。）bookmark41 测试项日（列出组装测试和确认测试屮每一项测试的内容、名称、目的和进度。）bookmark41 测试准备bookmark41 测试机构及人员（测试机构名称、负责人和职责。）5.3测试项目说明（按顺序逐个对测试项冃做出说明：）bookmark41 测试项日名称及测试内容bookmark41

12、 测试用例输入（输入的数据和输入命令。）输出（预期的输出数据。）步骤及操作bookmark41 进度bookmark41 条件（给出项测试対资源的特殊要求，如设备、软件、人员等。）bookmark41 测试资料（说明项测试所需的资料。）5.4测试计划执行情况bookmark41 测试项目（用表格的形式列出每一测试项目的名称、内容和目的。）bookmark41 测试机构和人员（给出测试机构名称、负责人和参与测试人员名单。）bookmark41 测试结果（按顺序给出每一测试项冃的：a.实测结果数据；c.该项测试表明的事实; d.该项测试发现的问题。）5.5评价bookmark41 软件能力（经过测

13、试所表明的软件能力o ）bookmark41 建议（提出为弥补上述缺陷的建议。）bookmark41 缺陷和限制（说明测试所揭露的软件缺陷和不足，以及可能给软件运行带来的影 响。）bookmark41 测试结论（说明能否通过。）六用户手册6.1引言bookmark41 编写冃的本手册主耍用来指导用户正确使用软件并解决常见问题，使用对彖为本软件的最终 使用者6.2系统功能介绍按照软件使用者的一般工作分工说明软件所具有的功能、这些功能帮助使用者解决实际 工作中的哪些问题、使用软件后的优点。6.3运行环境说明简单说明运行本软件所要求的：bookmark41 硬件设备环境，例如使用什么型号的计算机、配

14、备多少内存及硬盘等；bookmark41 系统软件的环境，例如windows> sql*net等；bookmark41 应用软件环境，例如运行木软件时需要在系统中有哪些其他子系统的支持等。必要时可以说明软件运行的基本环境和最佳环境。6.4运行前的准备说明这个软件在运行前用户应该作的准备工作，如：代码的编制、数据的准备、工作流 程的调整等等。在这里应该列出所需要做的准备工作清单，以告诉用户在使用前应做好的准 备工作。有些系统初始化的工作，特别是需要系统维护人员操作的安装和初始化工作操作方 法可在后血附录的安装与初始化中描述，在这里不必详细说明。6.5输入输出说明和操作说阴这一部分是用户手册

15、的核心，这部分内容应该按照工作的流程顺序來编写。对于每个相对独立运行的了系统或程序模块，应说明软件的进入和退出方法。（在 windows环境下的软件只盂说明快捷方式启动软件的方法即可，通常情况下不必再说明 用命令启动软件的方法。）在编写操作说明时为了用户使用的方便，应该针対每一个工作流程编写相应的软件操作 步骤和方法，具内容应该包括：bookmark41 功能简介。bookmark41 工作流程中相应软件模块的进入与退出方法。bookmark41 以醒口的方式列出常规工作吋操作步骤，详细说明每个步骤中的屏幕和便用方法bookmark41 这一部分应该尽屋让软件的使用操作人员对整个操作过程冇一个

16、明确的概念，在文 件编排上应该把使用者的注意力集中在使用软件解决他工作屮的问题上。bookmark41 対向计算机输入的数据和计算机输出的内容给予适当的说明。在语言上应该使用易于用户理解的词汇而尽量不耍用计算机专业术语。6.6安全与保密说明软件对保密管理的要求及违反保密规定后可能造成的后來。在一些子系统中，保密 字乱用后，可能造成个人工作量统计错误等等。6.7常见问题的处理根据需要说明在使用中可能遇到的问题及其解决方法。这些问题往往是山于在使用过程 屮的错谋操作造成的。对于一些能够预见的，经常町能遇到的问题应该在川户手册小提供解 决的方法，这样能够减少很多为用户提供使用咨询的工作罐。6.8附录：安装与初始化（必须提供）bookmark41 安装列出软件安装的步骤，说明安装过程屮的每一步操作方法