如何开发一个具有数据统计分析的app(如何进行数据分析统计)
2023-04-26 · 百度认证:重庆猪八戒网络有限公司官方账号
首先,你需要明白为什么需要文档。你要理解文档和代码一样重要,都是开发人员的劳动成果(artifact)。
其次,你要确定你采用的周期模型和开发方法。不同的模型或方法会有不同的文档需求,这需要你自己裁剪直到适合你的开发团队,别忘了,文档也是为了提高开发效率、质量用的,让开发人员过多的写一些无味的文档,反而会降低效率。
再次,你要作出一些文档模板,模板中对文档的用途和结构做出明确的说明。
最后,就可以填充啦。
附一个RUP的需求描述文档模板
1.0简介
[介绍本文档的整体结构。]
1.1目的
[说明本软件需求规格说明书的目的。软件需求规格说明书不仅需要完整的描述系统的行为,还需要说明非功能性的需求、设计约束以及其它相关的因素。]
1.2范围
[简要介绍本需求规格文档适用的项目/应用程序及其主要特性或其它子系统、相关的用例模型和受其影响的其它任何事物。]
1.3定义、术语和缩写
[详细定义正确地理解本文档的相关术语,包括定义、首字母缩写词和缩略语。可以通过引用术语表说明。]
1.4
[说明本文档引用的任何其它相关文档。要列出文档的标题、文档编号、日期、和出版单位并说明文档的来源。]
1.5概要
[说明本文档余下部分包含的内容及组织方式。]
2.0说明
[本节列出影响产品和需求的一般因素,但不需列出具体的需求,只需描述将在第3节中详细描述的需求的背景,以便于理解需求。这包括:产品总体效果,产品功能,用户特征,约束、假设和依赖,以及需求子集等。特别关键的是除了需要说明产品是或说解决什么,还要说明产品不是或不是解决什么。]
2.1用例模型
[如果使用了用例模型,本小节概述适用于本系统的用例模型或子模型,包括所有用例和角色的名称和简要说明及用例图和关系。可将用例报告作为附件在此引用。]
2.2假设与依赖
[说明所有重要的技术可行性、子系统或组件的可用性或可作为此说明书所描述的软件的基础的其它相关假设。]
3.0需求描述
[详细描述软件的需求。其详细程度能够使设计人员设计出满足这些需求的系统;测试人员能够测试此系统是否真的满足这些需求。在使用用例建模时,这些需求采用用例和可用的其它补充文档捕获。]
3.1用例报告
[用例模型通常定义了系统的主要功能性需求和一些非功能性需求。对用例模型中的每个用例都需要在此引用或附上用例报告。保证清晰的标明每个需求。]
3.2补充说明
[描述没有包含在用例中的其它需求。此处应包含补充需求说明中适用于此系统的具体需求说明或特征,并重新提炼以足够详细地说明此系统。这些信息可直接记录在此文档中,也可以作为附件引用到单独的补充说明文档。同样要保证需求被清晰的定义。]
4.0辅助信息
[辅助信息使此文档更容易使用。这可以是目录、索引、附录、用例示意图、用户界面原型等。如果包含附录,要明确说明此附录是否是需求的一部分。]