[软件工程]文档 总结

2024-08-26 19:58
文章标签 文档 总结 软件工程

本文主要是介绍[软件工程]文档 总结,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

    软工文档写完了之后对一些文档有了更深的认识,通过写文档也认识到了文档的重要性。我认为要明白每个文档的编写目的是什么,要给谁看,它的核心内容是什么。下面说一下对每一个文档的认识。

   (1)可行性研究报告

    它是在开发的开始时期编写的,属于定义阶段。

    目的:说明系统项目的实现在技术、经济和法律方面的可行性,评述为了合理的达到开发目标而可能选择的各种方案,说明并论证选择的方案,以供后期开发进行参考,为以后的为以后的整个开发过程做一个铺垫,项目经理或组长可以依此为参考进行决策。     

    读者:系统的管理人员,开发人员,项目负责人

    核心内容:可行性分析方面的内容

   (2)项目开发计划

    目的:为了给开发系统做主要的规划和整合,对系统的费用、时间、进度、组织、硬件设备的配置、开发环境的配置进行说明,为开发的下一步做准备。

读者:系统分析员、开发人员、项目组长

核心内容:期限和实施计划方面的内容。

(3)软件需求说明书

目的:方便用户进行查看自己的最初愿望有没有确定,是软件设计人员进行软件开发的出发点,系统维护人员发现和添加新功能的依据。

读者:用户、分析人员、软件设计人员,维护工作人员

核心内容:需求规定的内容

(4)概要设计说明书

整体说明软件的实现思路,指出关键技术难点。是开发阶段的文档

目的:在用户需求分析的阶段的基础上,对系统做概要设计,确定一个软件系统的体系结构。为软件系统提供所用的数据结构或者数据库结构,同时为下一阶段的详细设计做参考。

读者:项目设计和项目编码人员

核心内容:接口设计、处理流程、数据结构设计

(5)详细设计说明书

对概要设计的进一步细化,一般由各部分担当人员一句概要设计分别完成,最后再集成,是具体的实现细节,理论上可以照此编码。

目的:在概要设计的基础上进一步明确系统结构,为下一步系统的实现和测试做准备。

读者:程序开发人员和程序测试人员‘

核心内容:算法设计、数据结构设计、物理设计

  (6)数据库设计说明书

目的:说明项目的数据库设计、结构情况,用于开发人员进行项目设计,同时为后来的数据库维护工作提供使用说明,可以作为未来版本升级的重要资料

读者:开发人员、变成人员、维护人员

核心内容:结构设计

  (7)数据要求说明书

目的:为系统的实现提供所需要的数据,根据这些数据设计数据库。

读者:项目开发人员、变成人员、维护人员、数据库操作人员

核心内容:一些数据描述

  (8)测试计划

目的:机房收费系统已经基本完成,为了更好的完善项目,还需要对项目进行测试,发现程序中的错误或者没有遇到过的错误。

读者:维护人员

    核心内容:测试内容

  (9)测试分析报告

目的:对测试进行分析,明确系统出现的问题,以求寻找适当的解决办法,使系统更加完善

阅读人员:开发人员、编程人员、维护人员

核心内容:缺陷和建议

  (10)项目开发总结报告

目的:为了总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价,说明本项目的工作流程,工程开发中状况,最终结果,经验教训等。也可以作为维护项目的参考资料。

预期读者:开发人员、编程人员、维护人员

  (11)操作手册和用户手册

目的:让没有使用过的系统用户看到这个文档后可以懂得操作方面的基本知识,通过阅读此文档,用户可以掌握系统的使用方法和操作步骤

预期读者:维护人员、用户

核心内容:输入输出相关内容

  (12)开发进度月报

目的:为项目组长掌握开发进度提供最可靠的依据,高效的完成软件的开发,为项目的开发总结报告提供依据。

预期读者:项目组长,项目开发人员

核心内容:进度与计划

总结:

开始的时候忍不住看师辈们的博客,看他们是怎么写的,看几篇后发现他们的还是有很多不同的,每个人有每个人的理解,才知道要有自己思想才可以,不管他们的哪个是对的。前两个文档借鉴了一下大家的,可能有大部分是别人的想法。后面的自己写,实在不会的再上网查一下。文档编写的时候有的地方是可以借鉴别人的,但是只是作为参考,还是要自己独立完成。对于像数据流图、甘特图、编写目的等一定要掌握。


这篇关于[软件工程]文档 总结的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1109536

相关文章

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

详解C#如何提取PDF文档中的图片

《详解C#如何提取PDF文档中的图片》提取图片可以将这些图像资源进行单独保存,方便后续在不同的项目中使用,下面我们就来看看如何使用C#通过代码从PDF文档中提取图片吧... 当 PDF 文件中包含有价值的图片,如艺术画作、设计素材、报告图表等,提取图片可以将这些图像资源进行单独保存,方便后续在不同的项目中使

java常见报错及解决方案总结

《java常见报错及解决方案总结》:本文主要介绍Java编程中常见错误类型及示例,包括语法错误、空指针异常、数组下标越界、类型转换异常、文件未找到异常、除以零异常、非法线程操作异常、方法未定义异常... 目录1. 语法错误 (Syntax Errors)示例 1:解决方案:2. 空指针异常 (NullPoi

Python实现合并与拆分多个PDF文档中的指定页

《Python实现合并与拆分多个PDF文档中的指定页》这篇文章主要为大家详细介绍了如何使用Python实现将多个PDF文档中的指定页合并生成新的PDF以及拆分PDF,感兴趣的小伙伴可以参考一下... 安装所需要的库pip install PyPDF2 -i https://pypi.tuna.tsingh

Java反转字符串的五种方法总结

《Java反转字符串的五种方法总结》:本文主要介绍五种在Java中反转字符串的方法,包括使用StringBuilder的reverse()方法、字符数组、自定义StringBuilder方法、直接... 目录前言方法一:使用StringBuilder的reverse()方法方法二:使用字符数组方法三:使用自

Python批量调整Word文档中的字体、段落间距及格式

《Python批量调整Word文档中的字体、段落间距及格式》这篇文章主要为大家详细介绍了如何使用Python的docx库来批量处理Word文档,包括设置首行缩进、字体、字号、行间距、段落对齐方式等,需... 目录关键代码一级标题设置  正文设置完整代码运行结果最近关于批处理格式的问题我查了很多资料,但是都没

Python依赖库的几种离线安装方法总结

《Python依赖库的几种离线安装方法总结》:本文主要介绍如何在Python中使用pip工具进行依赖库的安装和管理,包括如何导出和导入依赖包列表、如何下载和安装单个或多个库包及其依赖,以及如何指定... 目录前言一、如何copy一个python环境二、如何下载一个包及其依赖并安装三、如何导出requirem

Rust格式化输出方式总结

《Rust格式化输出方式总结》Rust提供了强大的格式化输出功能,通过std::fmt模块和相关的宏来实现,主要的输出宏包括println!和format!,它们支持多种格式化占位符,如{}、{:?}... 目录Rust格式化输出方式基本的格式化输出格式化占位符Format 特性总结Rust格式化输出方式

Python自动化Office文档处理全攻略

《Python自动化Office文档处理全攻略》在日常办公中,处理Word、Excel和PDF等Office文档是再常见不过的任务,手动操作这些文档不仅耗时耗力,还容易出错,幸运的是,Python提供... 目录一、自动化处理Word文档1. 安装python-docx库2. 读取Word文档内容3. 修改

使用Python快速实现链接转word文档

《使用Python快速实现链接转word文档》这篇文章主要为大家详细介绍了如何使用Python快速实现链接转word文档功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 演示代码展示from newspaper import Articlefrom docx import