如何从软件开发的角度分析一个软件并将软件开发说明写出来?
来源:百度知道 编辑:UC知道 时间:2024/09/22 22:32:58
首先,你需要明白为什么需要文档。你要理解文档和代码一样重要,都是开发人员的劳动成果(artifact)。
其次,你要确定你采用的周期模型和开发方法。不同的模型或方法会有不同的文档需求,这需要你自己裁剪直到适合你的开发团队,别忘了,文档也是为了提高开发效率、质量用的,让开发人员过多的写一些无味的文档,反而会降低效率。
再次,你要作出一些文档模板,模板中对文档的用途和结构做出明确的说明。
最后,就可以填充啦。
附一个RUP的需求描述文档模板
1.0 简 介
[介绍本文档的整体结构。]
1.1 目的
[说明本软件需求规格说明书的目的。软件需求规格说明书不仅需要完整的描述系统的行为,还需要说明非功能性的需求、设计约束以及其它相关的因素。]
1.2 范围
[简要介绍本需求规格文档适用的项目/应用程序及其主要特性或其它子系统、相关的用例模型和受其影响的其它任何事物。]
1.3 定义、术语和缩写
[详细定义正确地理解本文档的相关术语,包括定义、首字母缩写词和缩略语。可以通过引用术语表说明。]
1.4 参考资料
[说明本文档引用的任何其它相关文档。要列出文档的标题、文档编号、日期、和出版单位并说明文档的来源。]
1.5 概要
[说明本文档余下部分包含的内容及组织方式。]
2.0 说 明
[本节列出影响产品和需求的一般因素,但不需列出具体的需求,只需描述将在第3节中详细描述的需求的背景,以便于理解需求。这包括:产品总体效果,产品功能,用户特征,约束、假设和依赖,以及需求子集等。特别关键的是除了需要说明产品是或说解决什么,还要说明产品不是或不是解决什么。]
2.1 用例模型
[如果使用了用例模型,本小节概述适用于本系统的用例模型或子模型,包括所有用例和角色的名称和简要说明及用例图和关系。可将用例报告作为附件在此引用。]
2.2 假设与依赖
[说明所有重要