3_设计文档编写规范

《3_设计文档编写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、2021-9-21设计文档编写规范1引言标蓝的为非必须写明的项目，其他项目必须写明。1.1编写目的说明编写这份设计文档的目的，并指出预期的读者（不是给开发看的要写明，如：上次我给华泰写的就是交流用的。此项不写则默认是给开发和测试的）。1.2背景说明：a．待开发软件系统的名称（如果正式名称未定，则列一个内部的名称，只要该项目的相关人员都清楚就可以了）；b．本项目的项目经理、产品经理、开发者、用户、运行该程序系统的数据来源（普通行情、level2、topview、财务数据库、网站采编、后台专人输入等）、运行该程序系统的计算中心（行情服务器

2、、选股服务器、网站等）。1.3定义列出本文件中用到专门术语的定义。说明：比如前段时间topview开发的“必赢108”就需要写清楚。1.4时间说明：a．本设计文档最后一次完成的时间；b．本设计文档开发所给的预计开发时间。1.5页码说明：由于设计文档一般都会比较长，所以大家都要标注页码。42021-9-211.6修改说明：a．每份文档要求有个版本号，每次大的修改要改版本号；b．本设计文档最后一次修改完成的时间；c．注明最近一次修改的内容。2程序系统的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之

3、间的层次结构关系。3程序1（标识符）设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层的内容相同，在这种情况下，只要简单地说明这一点即可。（例如：按钮的大小，一般说明一次就可以了。）3.1设计目标给出对该程序的简要描述，主要说明安排设计本程序的目的意义，如有必要，还要说明本程序的特点。（一般这一项需要结合业务目标、竞争对手比较、用户调查等文档一起说明。）还要说明该功能的适用用户群体（如：战略家）、用户使

4、用场景（如基于的分辨率等）3.2功能描述说明该程序应具有的功能，一般来说需要画出示意图（可找美工或者自己画，用笔画在纸上也可以，王文刚那里有扫描仪）。用户的操作及应有的响应。（人物设计：根据来自用户特性和任务分析的交互方式的需求说明）需要说明是网页还是程序实现。3.3开发人员一共有哪些人参与开发。42021-9-213.4开发时间开发本功能大体所需要的时间，一般单位为“工作日”。3.5性能说明对该程序的全部性能要求，包括对精度、响应时间（这个要重点注意，不容易写，但是要重视）和灵活性（比如，显示的内容可以随时通过后台修改等）的要求。3

5、.6输入项给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源（分为：人工输入、普通行情数据、普通财务数据、level2数据、topview数据、港股数据等）和安全条件（是否需要人工审核）等等。示例：名称：实时解盘。数据的类型和格式：文字、文本。数据值的有效范围：大约100到10000字。输入的方式：后台人工输入。数量和频度：交易时间每5分钟左右一条。输入工具：资讯发布平台。输入数据的来源：人工输入。安全条件：不需要人工审核。3.7输出项给出对每一个输出项的特性

6、，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，显示方式、以及对输出图形、符号、指标的说明等等。这个一般要求有示意图。3.8算法详细说明本程序所选用的算法，具体的计算公式和计算步骤。3.7流程逻辑用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。3.8帮助设计、出错信息设计说明准备在本功能中安排的帮助、说明，如：a．弹出Tip的说明；b．点“？”按钮弹出的说明；42021-9-21尽可能考虑本功能可能会出现的出错情况，安排或统一或差异化的出错信息设计3.9接口（非必须项目）说明本程序所隶

7、属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。3.12测试备注当该功能有特殊测试需求时，需要写明：对本程序进行测试时的注意事项，包括对测试的技术要求、输入数据、预期结果等的规定。3.13尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。4程序2（标识符）设计说明用类似F．3的方式，说明第2个程序乃至第N个程序的设计考虑。......4