软工文档编写总结

2024-08-25 19:18
文章标签 文档 总结 编写 软工

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

从看视频之前,就知道最后需要完成的是编写文档。可是最后视频看完后,对文档的编写一点头绪都没有。

在师父的英明指导下,这项工作终于不再是止步不前了。师父说,文档最重要的就是:每份文档应该在什么阶段编写、由谁编写、写给谁看以及每份文档其中包含什么内容。

有了这个思路,文档编写轻松了许多。所以,自己就将软件开发的生命周期与文档编写再次联系起来,各个不同阶段,就会相应地产生一份不同的文档。

所以,在之前总结的基础上,将需要产生的相应的文档添加上去。下面便是每个生命周期与各个文档的对应:


下面具体看各个文档:

阶段一:软件开发的分析阶段


本阶段包含三个文档,最初的可行性研究报告,就是对这项软件开发工作的是否可行进行分析。一开始,需要对项目的各方面都有所了解,加之对现有系统情况的把握,确定如何做到一个全新系统的方案。另外,加上对经济以及社会因素的考虑,最后得出该方案是否可行的结论。

对项目做完可行性研究后,可行的话,就需要开始总体规划,这时期就需要一个项目开发计划文档。其中内容包括对项目的概述、实施计划、支持条件等。

每款软件的开发最后都是需要面向用户的,所以对用户的需求必须做到清楚了解和认识。相应地,产生软件需求说明书,主要是综合用户各方面条件,对软件的目标、运行环境都加以说明。

阶段二:软件开发的设计阶段


本阶段共包含7个文档,从总体设计到最后的开发总结,每一个文档都是关键的一步。只有走好每一步,最后才有可能会更好。文档的内容要点就不再加以说明了。

阶段三:软件开发的维护阶段


本阶段虽然只需要编写一个文档,但工作任务还是繁重的。程序维护手册,主要包括对系统的用途、安全等方面的一个说明和对设备、软件及数据库方面操作环境的阐述,都是以便对程序更好地维护;其中每个维护过程也需要在文档中记录下来,包括约定、验证、出错及纠正方法。

除了软件开发整个生命周期的三个阶段,其实还需要编写一些其他管理性质的文档,如用户手册等。这可以算是后期的工作。除此之外,一个软件开发项目可能历时很久,所以就需要有个进度报告,从而有个看得见的文档,对系统的每一步都做好规划,因而保证开发工作能够如期完成。

阶段四:软件开发其他文档编写


从头至尾,共12篇文档,它们的完成,才算是一个软件开发项目真正完工。

对于这个阶段的学习,自己最大的感受就是:思路决定出路。自己的思路有了,才可能会看到一条光明的出路。之所以最初不知道如何开始,就是没有找到一条思路去做。在师父指导后,思路清晰了,后面的路也就顺畅了很多。

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



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

相关文章

C#如何在Excel文档中获取分页信息

《C#如何在Excel文档中获取分页信息》在日常工作中,我们经常需要处理大量的Excel数据,本文将深入探讨如何利用Spire.XLSfor.NET,高效准确地获取Excel文档中的分页信息,包括水平... 目录理解Excel中的分页机制借助 Spire.XLS for .NET 获取分页信息为什么选择 S

Java利用Spire.XLS for Java自动化设置Excel的文档属性

《Java利用Spire.XLSforJava自动化设置Excel的文档属性》一个专业的Excel文件,其文档属性往往能大大提升文件的可管理性和可检索性,下面我们就来看看Java如何使用Spire... 目录Spire.XLS for Java 库介绍与安装Java 设置内置的 Excel 文档属性Java

Python自动化提取多个Word文档的文本

《Python自动化提取多个Word文档的文本》在日常工作和学习中,我们经常需要处理大量的Word文档,本文将深入探讨如何利用Python批量提取Word文档中的文本内容,帮助你解放生产力,感兴趣的小... 目录为什么需要批量提取Word文档文本批量提取Word文本的核心技术与工具安装 Spire.Doc

C#高效实现在Word文档中自动化创建图表的可视化方案

《C#高效实现在Word文档中自动化创建图表的可视化方案》本文将深入探讨如何利用C#,结合一款功能强大的第三方库,实现在Word文档中自动化创建图表,为你的数据呈现和报告生成提供一套实用且高效的解决方... 目录Word文档图表自动化:为什么选择C#?从零开始:C#实现Word文档图表的基本步骤深度优化:C

使用Python将PDF表格自动提取并写入Word文档表格

《使用Python将PDF表格自动提取并写入Word文档表格》在实际办公与数据处理场景中,PDF文件里的表格往往无法直接复制到Word中,本文将介绍如何使用Python从PDF文件中提取表格数据,并将... 目录引言1. 加载 PDF 文件并准备 Word 文档2. 提取 PDF 表格并创建 Word 表格

C#借助Spire.XLS for .NET实现在Excel中添加文档属性

《C#借助Spire.XLSfor.NET实现在Excel中添加文档属性》在日常的数据处理和项目管理中,Excel文档扮演着举足轻重的角色,本文将深入探讨如何在C#中借助强大的第三方库Spire.... 目录为什么需要程序化添加Excel文档属性使用Spire.XLS for .NET库实现文档属性管理Sp

Java利用Spire.Doc for Java实现在模板的基础上创建Word文档

《Java利用Spire.DocforJava实现在模板的基础上创建Word文档》在日常开发中,我们经常需要根据特定数据动态生成Word文档,本文将深入探讨如何利用强大的Java库Spire.Do... 目录1. Spire.Doc for Java 库介绍与安装特点与优势Maven 依赖配置2. 通过替换

C# List.Sort四种重载总结

《C#List.Sort四种重载总结》本文详细分析了C#中List.Sort()方法的四种重载形式及其实现原理,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友... 目录1. Sort方法的四种重载2. 具体使用- List.Sort();- IComparable

SpringBoot项目整合Netty启动失败的常见错误总结

《SpringBoot项目整合Netty启动失败的常见错误总结》本文总结了SpringBoot集成Netty时常见的8类问题及解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参... 目录一、端口冲突问题1. Tomcat与Netty端口冲突二、主线程被阻塞问题1. Netty启动阻

SpringBoot整合Kafka启动失败的常见错误问题总结(推荐)

《SpringBoot整合Kafka启动失败的常见错误问题总结(推荐)》本文总结了SpringBoot项目整合Kafka启动失败的常见错误,包括Kafka服务器连接问题、序列化配置错误、依赖配置问题、... 目录一、Kafka服务器连接问题1. Kafka服务器无法连接2. 开发环境与生产环境网络不通二、序