软件文档写作 实训报告 超市管理系统

辽宁工业大学软件文档写作实训报告

题目：超市管理系统软件文档

院（系）: 软件学院

专业班级：电子商务092班

学号： 091401050

学生姓名：洪竹

指导教师：张莉莉

教师职称：助教

起止时间：2011.11.28-2011.12.03

实训任务及评语

目录

第1章实训目的与要求 (1)

1.1 实训目的 (1)

1.2 实训的实验环境 (1)

1.3 实训的预备知识 (1)

1.4 实训要求 (1)

第2章软件文档及其组成 (2)

2.1软件文档的作用及分类 (2)

2.2软件文档所采用的标准 (2)

2.2 软件文档的主要内容 (3)

第3章实例 (5)

3.1 超市管理系统软件需求说明书的编写实例 (5)

第4章实训日记 (12)

第5章实训总结 (13)

参考文献 (14)

第1章实训目的与要求

1.1 实训目的

本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。

1、了解软件开发周期各阶段的文档。

2、掌握各文档阐述的内容及作用。

3、了解文档所采用的国际、国家等相关标准。

4、了解各文档所涉及的软件知识。

5、掌握各文档采用的描述工具。

6、具体编写出2个主要的软件文件。

1.2 实训的实验环境

学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。

1.3 实训的预备知识

要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。

1.4 实训要求

实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。

第2章软件文档及其组成

2.1软件文档的作用及分类

软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本

说明文档等。

软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。

软件文档可按照基于软件生存期方法以及根据其产生和使用的范围两大类分类。

1.基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。

2.软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。

其中，开发文档包括：可行性研究报告，项目开发计划，软件需求说明书，数据库设计说明书，概要设计说明书，详细设计说明书。

用户文档包括：用户手册，操作手册，软件需求说明书，数据要求说明书。

管理文档包括：项目开发计划，模块开发卷宗，开发进度月报，测试计划，测试分析报告，项目开发总结报告。

而供开发人员使用的文档为可行性研究报告，项目开发计划，软件需求说明书，数据要求说明书，概要设计说明书，详细设计说明书，数据库设计说明书，测试计划，测试分析报告。

维护人员使用的文档为设计说明书，测试分析报告，模块开发卷宗。

管理人员使用的文档为可行性研究报告，项目开发计划，模块开发卷宗，开发

进度月报，项目开发总结报告。

用户使用的文档则为用户手册和操作手册。

2.2软件文档所采用的标准

1.根据软件工程标准制定的机构和标准适用的范围，可分为4个层次：

(1)国际标准: ISO 国际标准化组织

(2)国家标准:GB中国ANSI美国BS英国JIS日本

(3)行业标准: IEEE

(4)企业(机构)标准: IBM

IBM（International Business Machines Corporation），国际商业机器公司，或万国商业机器公司的简称。

IBM公司同时也是备受世人尊重的公司。受人尊重的原因，其中之一是能够在近百年的历史过程中，多次领导产业革命，尤其是在IT行业中，制定多项标准，并努力帮助客户成功。另外，该公司一直在世界500强中位居前列。更为重要的是，其受人尊重的原因在于，IBM公司近百年的历史当中，一直坚持遵守“沃森哲学”。

在1914年创办IBM公司时，托马斯为公司制定了“行为准则”，这些准则一直牢记在公司每位人员的心中，任何一个行动及政策都直接受到这三条准则的影响，“沃森哲学”对公司的成功所贡献的力量，比技术革新、市场销售技巧，或庞大财力所贡献的力量更大，主要包括：

必须尊重个人；

必须尽可能给予别人最好的服务；

必须追求优异的工作表现。

IBM新的政策的原则如下：

根据标准化机构所制定的标准质量及其流程、会员制度和知识产权政策的开放程度，决定是否参加或退出该标准化机构。

倡导新兴国家和发达国家采用开放的全球标准、并参与这些标准的制定。

推动标准化机构建立规章制度，以保证技术决策、投票和争议解决由独立的参与者公正做出，避免受到不当利益的影响。

与标准化机构和开发者社区合作，确保可以自由地获得和实施开放的软件互操作标准。

协力推动标准化机构创建清晰、简洁和贯彻始终的知识产权政策，使得标准开发者和实施者可以在信息透明的环境下做出技术和商业决策。

IBM倡导标准化社区的成员采用类似的原则，它们比现存法律和政策的要求更加严格。IBM新的标准化政策推崇简化和统一的知识产权操作规程，强调包括开源社区和成长型市场在内的所有利益相关方在参与标准化过程中一律平等。

2.3 软件文档的主要内容

本软件文档是超市管理系统软件文档。超市系统软件文档包括超市系统操作手册、超市系统测试计划、超市系统概要设计说明书、超市系统可行性分析报告、超市系统需求说明书、超市系统详细设计说明书、超市系统项目计划、超市系统项目总结报告、超