软件工程开发文档写作教程
文章平均质量分 74
软件文档是整个软件开发工作的基础,现代工程化的软件开发离不开软件文档。软件文档体系的建立与软件开发阶段密切相关,是软件开发整个生命周期中必不可少的一部分,软件生命周期始于软件文档,软件文档贯穿着整个软件生命周期。
谷哥的小弟
历任研发工程师,技术组长,项目经理;曾于2016年、2020年两度荣获CSDN年度十大博客之星。
十载寒冰,难凉热血;多年过去,历经变迁,物是人非。
然而,对于技术的探索和追求从未停歇。
坚持原创,热衷分享,初心未改,继往开来!
展开
-
CMMI软件能力成熟度评估标准
CMMI,全称为Capability Maturity Model Integration,即能力成熟度模型集成,是在原有的CMM(Capability Maturity Model For Software,软件能力成熟度模型)基础上进一步发展而来的。这一模型由美国卡耐基梅隆大学软件工程研究所(SEI)领衔全球软件过程改进和软件开发管理领域的专家,经过多年的精心研发而推出。随后,SEI在全球范围内推广并实施了这一软件能力成熟度评估标准。CMMI不仅用于指导软件开发过程的改进,还用于评估软件开发的能力。原创 2024-06-06 20:15:00 · 822 阅读 · 0 评论 -
软件工程开发文档写作教程(15)—概要设计书的编写
一个系统编写一份概要设计书,概要设计书的内容可以完全按照国家规范来写,也可以参照公司以往的概要设计书自由地裁剪。注意编写概要设计书时一定要把握全局、分清楚主次,不盲目深入细节。原创 2023-06-12 02:45:00 · 637 阅读 · 1 评论 -
软件工程开发文档写作教程(14)—概要设计书的内容
在概要设计阶段,我们还需要制定规范,包括代码体系、接口规则、命名规则。这是软件开发的基础,有了开发规范、接口规则、方式方法,开发者就有了共同的工作语言、共同的工作平台,使整个软件开发工作可以协调有序地进行。原创 2023-06-12 01:15:00 · 214 阅读 · 0 评论 -
软件工程开发文档写作教程(13)—概要设计书的基本要求
概要设计书不是详细设计书,它把握系统的整体方向,起着提纲挈领的作用。在概要设计阶段不能陷入具体的实现细节,不要盲目的追求详尽而失去重点。原创 2023-06-12 01:00:00 · 236 阅读 · 0 评论 -
软件工程开发文档写作教程(12)—概要设计书的编制目标
在软件需求分析阶段,已经搞清楚了软件“做什么”的问题,并把这些需求通过规格说明书描述了出来,这也是目标系统的逻辑模型。进入了设计阶段,要把软件“做什么”的逻辑模型变换为“怎么做”的物理模型,即着手实现软件的需求,并将设计的结果反映在“设计规格说明书”文档中,所以软件设计是一个把软件需求转换为软件表示的过程,最初这种表示只是描述了软件的总的体系结构,称为软件概要设计或结构设计。原创 2023-06-12 00:30:00 · 1706 阅读 · 1 评论 -
软件工程开发文档写作教程(07)—招投标文件写作规范
国内的软件项目招投标文件的写作规则并不存在行业标准。许多大型企业的信息化主管在他们的工作中,总是相互传递着一种或多种招标文件的写作规则,而没有多少人关心规则的出处。主管们总是认为,有规则总比没有好,只要能够用,能够把问题说清楚就可以。这里给出一个招投标文件写作规则的参考规范。原创 2023-05-10 21:58:41 · 1263 阅读 · 0 评论 -
软件工程开发文档写作教程(06)—项目建议书写作规范
项目建议书一般是由主策划或者项目经理负责编写的。进行可行性分析是一个自我否定的过程,而写项目建议书是一个向别人阐述自己观点的过程。而且项目建议书一般情况下是要去说服你的上司或者投资人来做这个项目,所以一定要非常完善,把所有可能的利弊都分析到。了解一个项目是如何才能达到立项标准,会加深对策划的进一步认识,避免把精力投入到不能成为项目的狂想中去。一份合理的项目建议书会让上司或者投资人更清楚你的设计思想是否完善,要努力说明这个项目的亮点和创新的地方来打动他们原创 2023-05-10 21:57:47 · 1023 阅读 · 0 评论 -
软件工程开发文档写作教程(05)—可行性研究报告写作规范
一个软件项目从立项到结尾共有几个阶段:立项,需求分析,概要设计,详细设计,软件编码,软件测试,维护,验收。在这几个阶段中,每一个阶段都有各自的文档内容及格式,但是国内目前存在以下一些现状原创 2023-05-10 21:56:53 · 1211 阅读 · 0 评论 -
软件工程开发文档写作教程(11)—需求分析书的编写
需求分析书虽然是由软件开发人员编写的,但最终的读者却不是软件开发人员,而是委托开发的客户,这些客户大多是熟悉公司业务流程的高层,他们是自己工作领域中的专家,但是对软件却知之甚少。正因为这样,需求分析书可以而且必须在满足标准的前提下,结合客户的实际情况,与客户充分交流积极探讨,力争写出让客户易于理解又无歧义的需求分析书。原创 2023-06-12 00:15:00 · 1014 阅读 · 0 评论 -
软件工程开发文档写作教程(10)—需求分析书的适用范围
在需求分析阶段,软件系统分析师等高层软件工作者将与客户一起探讨将要开发的软件需要具备的功能、性能等方面的需求。系统分析师们将这些需求用文字的形式记录下来,按照一定的书写规范形成需求分析书,提供给客户审核,客户提出修改意见,系统分析师修改需求分析书,然后再审核再修改,如此反复多次最终定稿。由此可见,需求分析书是需求分析阶段的最终产物,它在需求分析阶段孕育生成,在未来的概要设计阶段发挥至关重要的作用,限定着软件项目的功能范围和性能要求。原创 2023-05-15 08:03:46 · 264 阅读 · 1 评论 -
软件工程开发文档写作教程(09)—需求分析书的基本要求
内容决定文章的深度,是思想结晶的灵魂,适用于文学创作的原则在软件文档的编写方面同样适用。所以我们一定要正确把握需求分析书的内容,以客户的视角去评审需求阶段的文档,不在需求分析书中加入具体设计细节的描述。同时需求分析书的内容应该是完整的,至于需求分析书要包含哪些内容,可以参考国家已经制定的文档规范原创 2023-05-15 08:03:30 · 245 阅读 · 0 评论 -
软件工程开发文档写作教程(08)—需求分析书的编制目标
对于大中型的软件系统,很难直接对它进行分析设计,人们经常借助模型来分析设计系统。模型是现实世界中的某些事物的一种抽象表示,抽象的含义是抽取事物的本质特性,忽略事物的其他次要因素。因此,模型既反映事物的原型,又不等于该原型。模型是理解、分析、开发或改造事物原型的一种常用手段。例如,建造大楼前常先做大楼的模型,以便在大楼动工前就能使人们对未来的大楼有一个十分清晰的感性认识,显然,大楼模型还可以用来改进大楼的设计方案。原创 2023-05-15 08:03:01 · 612 阅读 · 0 评论 -
软件工程开发文档写作教程(04)—开发文档的编制策略
仅仅依据规章、传统的做法或合同的要求去制作文档是不够的。管理者还必须确定文档的质量要求以及如何达到和保证质量要求。质量要求的确定取决于可得到的资源、项目的大小和风险,可以对该产品的每个文档的格式及详细程度做出明确的规定。原创 2023-04-24 20:57:15 · 535 阅读 · 0 评论 -
软件工程开发文档写作教程(03)—开发文档的必备条件
软件系统配备软件文档不仅对于公司非常有益,而且也能够让客户从中受益。由于软件产品如何使用在某种程度上是要依赖软件文档来进行说明的,因此软件文档必须准确可靠。使用不准确的和已经过时的软件文档对于公司的发展也会产生一定的阻碍,同样也会对客户产生消极的影响。一旦客户发现在他们使用产品的时候遇到了问题,却不能通过求助于伴随软件产品的软件文档的手段进行解决的时候,客户就会对这种软件产品产生怀疑乃至于失去信心,公司的信誉和利益自然而然地就会受到损害。原创 2023-04-24 20:15:00 · 475 阅读 · 0 评论 -
软件工程开发文档写作教程(02)—开发文档的分类
可行性研究报告的编写目的是说明该软件开发项目的实现在技术、经济和社会条件 方面的可行性,评述为了合理地达到开发目标而可能选择的各种方案,说明并论证所选定的方案。可行性研究报告的内容包括可行性研究的前提,对现有系统的分析,所建议的系统,可选择的其他系统方案,投资及效益分析,社会因素方面的可行性和结论。原创 2023-04-24 02:45:00 · 824 阅读 · 0 评论 -
软件工程开发文档写作教程(01)—开发文档的意义与作用
软件文档是整个软件开发工作的基础,现代工程化的软件开发离不开软件文档。软件文档体系的建立与软件开发阶段密切相关,是软件开发整个生命周期中必不可少的一部分,软件生命周期始于软件文档,软件文档贯穿着整个软件生命周期。原创 2023-04-20 22:46:28 · 1141 阅读 · 1 评论