编写软件设计文档的一些要素

名称		条件	备注说明
系统边界	1、系统运行环境	windows 7以上的windows系统，.net framework 4.0支持 计算机硬件要求：   处理器：1GHz 32位或者64位处理器   内存：4GB 及以上   显卡：支持DirectX 9 128M 及以上（开启AERO效果）   硬盘空间：500G以上（主分区，NTFS格式）   显示：分辨率大于等于1024*768
	2、开发环境	系统开发平台：windows10专业版，IDE使用，Microsoft Visual Studio 2019 系统开发语言：C# 数据库：MSSQLServer 2014 数据库名称：**** 系统间通讯方式：TCP/IP Socket通讯
	3、功能边界	参见系统设计功能图
	4、应用边界		适用于什么场景
性能与效率	1、记录存储	20W条以上记录
	2、系统对用户请求响应时间	≤1s	系统对用户请求做出响应所需要的时间
	3、数据处理时间、网络传输	≤3s
	4、核心算法及日志记录	用缓存机制提高性能，降低I/O
	5、并发用户数	同一时间满足≥100人登录，数据查询
	6、吞吐量	a）≥请求数/s	指单位时间内系统能够完成的工作量； 吞吐量是软件系统衡量自身负载能力的一个很重要的指标，吞吐量越大，系统单位时间内处理的数据就越多，系统的负载能力就越强。
		b）≥页面数/秒
		c）≥访问人数/天
		d）≥处理业务数/小时
	7、TPS( Transaction per Second)	≥100	TPS是指系统每秒钟能够处理的事务和交易的数量，它是衡量系统处理能力的重要指标
	8、点击率( Hits per Second)	允许≥100	用户每秒向Web服务器提交的HP请求数
	9、资源利用率	CPU≤50%，内存小于2G，网络流量占用率≤50% 例：承受10000 用户的并发访问时，Web 服务器的CPU占用率为68%，平均的内存占用率为55%	软件对系统资源的使用情况，包括CPU利用率、内存利用率、磁盘利用率等
	10、SQL语句效率	程序请求的SQL，存储过程、函数等SQL语句≤3s
质量属性	系统性	a)兼容性 软件能够兼容Windows 7及以上版本操作系统。 b)扩展性 系统采取易于扩展的架构，易于增加新的功能。 c)灵活性 系统采用xml或json字符串作为参数，灵活适应环境和需求的变化
	易用性	a)可辨识性 软件帮助文档包含各个功能的介绍及使用说明。 b)易学易操作 界面简明扼要，避免过于复杂的操作。 c)用户差错防御性 各文本、数字输入框包含按键屏蔽、输入值校验，各有时间顺序的流程在软件中做逻辑判断并给予提示，避免误操作。 d)用户界面舒适性：各窗口间功能划分合理，各界面风格保持一致，软件操作符合大众操作习惯。
	依从性	a)华燕C#软件开发编码规范 b)故障码定义规范
	可靠耐久性	a)成熟可用性 采用C#的编程语言进行开发编码，使用传统三层架构和模块式开发，满足软件的系统正常工作的时间所占的比例≥90%。 b)容错性 涉及到可能会引发异常的程序段时做特殊处理，避免程序卡死； 在软件设计时增加必要的冗余设计，防止错误的资源控制锁导致某个资源长期被占用，导致系统崩溃或卡死，在数据存储中使用定时自动备份设计消除系统中的数据丢失故障； 在通讯中通过命令校验发现传输错误的指令，防止恶意攻击。
	维护性	a）可替换性 各检测功能模块结构设计为模块化，需易更换，同时方便移植开发利用。 b）软件日志可追溯 软件系统中有运行日志、操作日志，记录了关键节点运行时间、状态操作、操作时间及操作人员相关信息，软件系统出现故障时易于分析。 c)易于理解 软件使用通用语法、注释清晰明了，维护及二次开发人员易于理解，上手快捷方便
	测试性	a)系统模块化设计，提高可测试； b)环境搭建简洁，易于测试。 c)软件功能与需求规范对应，易于理解，方便测试
	安全性	a)通过系统登录、权限分配系统在向合法用户提供服务的同时能够阻止非授权用户使用的企图或拒绝服务的能力 b)通讯使用加密、验证码校验的方式保证系统通讯的安全性