软件设计编码规范
质量管理体系过程文件软件设计编码过程
文件版本信息：
目录
1.目的 (3)
2.范围 (3)
3.术语 (3)
4.角色与职责 (3)
5.入口准则 (3)
6.输入 (3)
7.流程图 (3)
8.主要活动 (4)
8.1.设计原则 (4)
8.2.设计方法................................................................................. 错误！未定义书签。
8.3.多方案选择 (4)
8.4.概要设计................................................................................. 错误！未定义书签。
8.4.1.概要设计......................................................................... 错误！未定义书签。
8.4.2.概要设计评审................................................................. 错误！未定义书签。
8.5.详细设计................................................................................. 错误！未定义书签。
8.5.1.详细设计 (5)
8.5.2.详细设计评审 (6)
8.6.编码......................................................................................... 错误！未定义书签。
8.7.单元测试 (7)
8.8.代码走查 (7)
8.9.制作用户文档......................................................................... 错误！未定义书签。
8.10.变更......................................................................................... 错误！未定义书签。
9.输出 (8)
10.出口准则 (8)
11.引用文档 (8)
1.目的
设计编码的目的在于设计和实现关于需求的解决方案。保证《需求规格说明书》中的各项要求在设计时都能够得到满足；对项目的编码实现进行质量控制，保证编码实现活动按计划顺利完成并与设计相一致。
2.范围
适用于公司的各类软件项目的系统设计编码过程。
3.术语
无
4.角色与职责
5.入口准则
●《需求规格说明书》已通过评审。
6.输入
●《需求规格说明书》
7.流程图
图1: 系统设计编码过程
8.主要活动
系统设计编码过程包括系统设计、系统实现。系统设计是指设计软件系统的体系结构、数据库、模块等，在需求和代码之间建立桥梁，一般分概要设计和详细设计两个阶段；系统实现是指开发人员按照系统设计去编码开发，并进行单元测试、代码走查；在设计编码过程中同时进行用户文档的编制。
8.1.概要设计
概要设计是分析各种设计方案和定义软件体系结构的过程。设计人员在充分了解需求的基础上，依据《需求规格说明书》选用适当的设计方法，分析与设计软件的结构、模块功能。通过系统分解，确定子系统的功能和子系统之间的关系，以及模块的功能和模块之间的关系，编写《概要设计说明书》。《概要设计说明书》必须经过技术评审。
8.1.1.解决方案选择
系统设计时可能会涉及到多种解决方案的选择，如：
●系统实现路线；
●采用的工具和技术；
●产品架构；
●设计模式；
●模块的制作、购买或重用等。
当出现多种候选方案，难以通过简单的方法判断出方案的优劣时，应按照《S_DAR00_决策分析和决定过程》进行决策。
8.1.2.概要设计
概要设计是建立整个软件的体系结构，包括子系统、模块以及相关层次的说明、每一模
块的接口定义等。概要设计的主要步骤有：
?选择设计方法；
?识别解决方案的主要组件：根据解决方案的技术架构和分析方法（面向对象、面向
结构），相应确定解决方案的组件模块；
?对候选技术和工具、组件进行评估，确定是进行开发、购买还是复用已有技术（工
具或者组件）。评估开发、购买或复用方案时需要考虑的事项包括：业务方面：可
行性、产品成本、经验、投资回报、成熟度及其他因素；企业体系结构方面：解决
方案必须与当前状态和远景状态计划的约束相适应。包括与企业现有系统的集成
等；技术方面：安全、组件模块交互标准、数据访问、数据存储、系统服务、开发
工具、操作系统等。
?识别解决方案主要组件的重要属性和关键关系：在前一任务的基础上，对解决方案
主要组件的重要属性和关键关系进行识别；
?进行数据库设计，建立数据库的逻辑模型和物理模型；
?进行用户界面设计，确定整个系统的界面框架以及界面风格；
?形成《概要设计说明书》。
8.1.3.概要设计评审
概要设计的结果应进行技术评审。技术评审由设计人员提出，由项目经理组织召开。技术评审会议应邀请需求分析师、公司的技术专家、开发人员、测试人员等参加。
关于技术评审会议的要求详见《评审过程》。
8.2.详细设计
详细设计可以和概要设计并行进行，但应考虑并行设计不会因概要设计而导致较大的详细设计返工。
8.2.1.详细设计
详细设计是从开发需求的角度描述解决方案的组件、服务和技术的过程。详细设计定义了解决方案的各个组成部分，以及这些组成部分的开发方法和交互方式。详细设计的步骤包括：
?选择用于开发解决方案的技术并完善设计模型：在概要设计的基础上，选择开发解
决方案采用的技术，并且完善对应的设计模型。
?确定分发和打包策略：分发和打包策略决定了最终各模块功能服务在解决方案体系
结构中的位置以及模块功能服务在哪个组件的基本原理。设计时需要在理解客户业
务环境、业务架构现状和发展趋势的基础上，考虑设计的可伸缩性、性能、可管理
性、重用性。此外，高内聚性、低耦合性是优秀组件模块设计的特征之一，需要作
为设计参考。
?将组件和服务打包：根据解决方案的基础架构，将各功能组件模块分布到基础架构
的各个部分。
?将组件分发到网络拓扑中：将应用程序模块与网络、物理服务器拓扑联系起来构成
部署模型。
?确定编程模型：编程模型是一组特定的准则，提供了一致性的组件实现。编程模型
包含了：实现技术、状态对象和无状态对象、进程内函数调用和进程外函数调用、内聚性和耦合性、连接模型和非连接模型、同步编程模型和异步编程模型、线程模
型、错误处理、安全性和分发等方面的准则。
?指定详细的组件接口、属性和服务：包括了组件接口设计、用户详细界面设计。
?详细设计输出《详细设计说明书》。
8.2.2.详细设计评审
详细设计根据设计需要确定是否进行评审。一般，以下情况应进行详细设计评审：
●新业务的设计；
●涉及3个及以上业务流程的设计；
●复杂算法和数据结构的设计；
●新设计人员设计的结果。
技术评审由详细设计人员提出和组织召开。技术评审会议应邀请概要设计人员、开发人员等参加。
关于技术评审会议的要求详见《评审过程》。
8.3.编码实现
8.3.1.开发环境准备
代码开发前应对开发环境进行规范并搭建开发环境。开发环境搭建应考虑的内容有：●开发服务器环境（开发数据库、源代码管理、网络、项目组门户等）；
●开发工具及版本；
●编码涉及的复用组件及版本；
●代码目录结构；
●编码规范等。
开发环境应由开发负责人配置好后，对开发人员进行培训。
8.3.2.代码编写
开发人员根据《详细设计说明书》进行编码实现。代码编写应考虑以下两个方面：
●编程方法：为提高代码的质量，可使用一些有效的编程方法来编制软件。常见的编
程方法有：结构化编程、面向对象编程、重用已有代码或者组件等。此外代码编写
根据所使用的开发语言不同，应该遵循相应的编码规范。
●编程实现顺序：根据《项目进度计划》确定各功能单元的编程顺序，在编程过程中
要严格按顺序来进行编码。
8.3.3.单元测试
单元测试的目的是为保证编写的每个代码单元片段功能实现满足设计要求，提高提交的代码质量而由开发人员进行的测试工作。单元测试指通过设计测试用例，执行待测程序来跟踪比较实际结果与预期结果来发现错误。
单元测试由模块开发人员进行，有条件的可以由其它开发人员进行互换测试。
单元测试需要关注以下几个方面：
源代码编译-----测试代码是否通过编译。
SQL脚本-----测试数据库脚本、存储过程运行是否正常。
模块接口-----对被测模块，信息是否能正确地流入和流出。
局部数据结构-----在模块的工作过程中，其内部的数据能否保持其完整性。
出错处理-----检查模块的错误处理是否有效。
可关注以下几个方面：
边界条件-----在边界上模块是否能正常工作。
覆盖条件------模块的运行是是否满足设计的逻辑要求。
建议引用测试工具自动执行单元测试。
测试结果形成《单元测试报告》，纳入配置管理。
利用工具自动执行单元测试的，可由工具直接导出《单元测试报告》；
完成各模块的单元测试后，开发人员填写《需求跟踪矩阵》的相关编码模块。
8.3.4.代码走查
软件模块经过单元测试，由开发经理在进度计划中策划并安排开发人员进行程序代码走查。
代码走查策划的原则可以从以下几个方面关注:
◆新员工编写的代码
◆关键业务或系统核心代码
◆问题较多的代码
◆新增模块的代码等
◆让步发布或发到用户现场测试的代码
开发经理可以在项目的PDP说明中策划确认代码走查策划的原则，并在进度计划中安排代码走查的任务。
代码走查由开发经理确定是个人走查或是团队走查。
8.4.用户文档编写
作为最终产品的一部分，项目还应编写《用户使用手册》、用户培训教材等用户文档。由测试人员在验收测试完成前完成用户文档的编写。
用户文档经过项目经理验证后纳入配置库中进行管理。
9.输出
●《概要设计说明书》
●《详细设计说明书》
●源代码
●《单元测试报告》
●《用户操作手册》
●《用户安装手册》
10.出口准则
●设计文档评审通过
●代码通过单元测试和代码走查
●完成用户文档
11.引用文档
●决策分析和决定过程
●评审过程
●变更管理过程
系统界面设计规范
B/S 系统界面设计规范 1.引言 界面美观、操作易用性、维护成本低是评价B/S系统的关键。本规范参考了一些成熟产品科学的开发方法，将开发过程中的方式、规则等强行的约束。希望藉此来提高用户操作感受，提升B/S产品的质量。 1.1. 编写目的 广义的界面概念包含了除页面布局设计之外，交互性的设计，及人体工程学方面的研究。本规范制订的依据从广义概念出发，总结以往项目的成败经验，目的是从整体上提升公司B/S类产品的质量、开发效率。从以技术为中心发展为以客户为中心，将类似项目成功的经验继承和积累下来，将B/S系统与C/S系统开发过程上的区别降低到仅显示控制的极小的层面。新的开发方式强调分层，规范出界面设计人员做什么，服务器编程人员做什么，这样就把页面和控制代码两个层面清晰的分开。 1.2. 背景 B/S模式系统以其易部署、易扩展、能够高度集成各种技术的特点，在公司产品线中占越来越大的比重，.Net、J2ee等技术的发展更是将B/S系统的开发和桌面应用程序开发的工程方法统一起来，突出服务器端技术，这些变革要求界面设计人员和服务器端编程人员可以应用更加科学的方法合作，团队的合作方式甚至决定了一个系统开发的成败。目前公司较多的服务器端编程人员仍然处于“后ASP 时代”的开发方式，表现为前台页面仍然与服务器代码高度的关联，带来的后果是重复建设、高昂的维护成本或失去控制的项目，没有充分的发挥出集成开发工具的优势。在以往的开发方式下界面设计侧重在静态页面的建设上，每个页面作为一个独立的模块来处理，在页面交互中则是程序员根据自己的习惯来控制，程序对个人的编程风格的依赖很强，这些在以往开发WEB站点的方式扩展到B/S系统有时是不正确的，甚至是背道而弛的，当然也不利于规模化的团队合作。 1.3. 定义 术语定义： 效果图：由界面设计人员设计的页面效果图，综合了概要设计的业务需要和整个站点的风格，它规定了页面布局上的每个细节。 容器：即HTML 标记的嵌套结构，如在表格->行->单元格内放置图片，那么可以认为单元格是放置图片的容器。 样式表：即级联式样式表CSS，它是W3C机构在HTML标记语言上扩展的格式语言。 非标准交互控件：是通过标准控件组合、扩展等方法以提高特定业务执行效率而进行封装的控件，或概括为用户根据以往的操作经验不能够直接领会出操作方式的交互控件。 2. 界面设计规范细则 总体目标 以规范作为基本原则，在此框架内进行合理的扩展和变化，将站点内的每个模块服从于整个站点，模块页面与“高内聚”的控制代码紧密的结合在一起，同时对应于应用程序基于系统的架构分析。 2.1. 通用原则 1 界面色彩要求：计算机屏幕的发光成像和普通视觉成像有很大的不同，应该注意这种
数据库设计和编码规范
数据库设计和编码规范 Version
目录
简介 读者对象 此文档说明书供开发部全体成员阅读。 目的 一个合理的数据库结构设计是保证系统性能的基础。一个好的规范让新手容易进入状态且少犯错，保持团队支持顺畅，系统长久使用后不至于紊乱，让管理者易于在众多对象中，获取所需或理清问题。 同时，定义标准程序也需要团队合作，讨论出大家愿意遵循的规范。随着时间演进，还需要逐步校订与修改规范，让团队运行更为顺畅。 数据库命名规范 团队开发与管理信息系统讲究默契，而制定服务器、数据库对象、变量等命名规则是建立默契的基本。 命名规则是让所有的数据库用户，如数据库管理员、程序设计人员和程序开发人员，可以直观地辨识对象用途。而命名规则大都约定俗成，可以依照公司文化、团队习惯修改并落实。 规范总体要求 1.避免使用系统产品本身的惯例，让用户混淆自定义对象和系统对象或关键词。 例如，存储过程不要以sp_或xp_开头，因为SQL SERVER的系统存储过程以 sp_开头，扩展存储过程以xp_开头。 2.不要使用空白符号、运算符号、中文字、关键词来命名对象。 3.名称不宜过于简略，要让对象的用途直观易懂，但也不宜过长，造成使用不方 便。 4.不用为数据表内字段名称加上数据类型的缩写。 5.名称中最好不要包括中划线。
6.禁止使用[拼音]+[英语]的方式来命名数据库对象或变量。 数据库对象命名规范 我们约定，数据库对象包括表、视图（查询）、存储过程（参数查询）、函数、约束。对象名字由前缀和实际名字组成，长度不超过30。避免中文和保留关键字，做到简洁又有意义。前缀就是要求每种对象有固定的开头字符串，而开头字符串宜短且字数统一。可以讨论一下对各种对象的命名规范，通过后严格按照要求实施。例如：
软件设计文档国家标准GB8567
软件设计文档国家标准GB8567-88 一、文档编写标准化 在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。 完备的文档对软件的开发及使用起了很大的作用。一般要求编写好十三种文档。 1、可行性分析报告 说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 2、项目开发计划 为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 3、软件需求说明书（软件规格说明书） 对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 4、概要设计说明书 是概要设计阶段的工作总结。主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。 5、详细设计说明书 着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 6、用户操作手册 详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。 7、测试计划 包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。8、测试分析报告 测试计划的执行情况，对测试结果的分析，提出测试结论。 9、开发进度月报 按月提交的项目进展情况报告。包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。 10、项目开发总结报告 项目完成以后，总结实际执行情况。如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。 11、软件维护手册 主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。12、软件问题报告 记录软件出现问题的日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。13、软件修改报告 软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、修改意见、修改可能出现影响作出详细描述，提交审批。 二、可行性分析报告的撰写要求 可行性研究报告的编写内容要求如下： 1 引言
软件系统页面设计规范
系统页面设计规范V1.0 柯建树2013/07/30
目录 一、基础规范 01、系统宽、高度 02、文本框设计规范 (1)基础规范 (2)应用场景 03、页码设计规范 (1)普通页码翻页 (2)小型页码翻页 04、文字的编排与设计 (1)文字大小 (2)文字颜色 (3)文字行距 (4)英文字体规范 (5)文字链接 05、整齐的概念和应用 06、模块化表现 二、参考指南 01、页面修饰 (1)简单的光影效果
(2)质感的表现 (3)透明效果的应用 02、个性皮肤的应用 03、图标的统一使用 04、图标表意 05、表格
基础规范 一、系统宽、高度 显示器分辨率比例 在软件系统的使用上，遵循以大多数为视觉标准，同时遵循其他分辨率的显示效果。 软件系统一般采用满屏显示内容，宽度为100%，高度100%，在设计网页时，应与使用量最大的分辨率作为参照，即1024px*768px。在这个尺寸上，系统应当具有全部显示的能力。 不同浏览器，不同分辨率下网页第一屏最大可视区域
在IE下，宽度21表示17px的滚动条加上4px的浏览器边框，做到全部兼容，以小分辨率设计，目前我们系统的设计标准是1003*600。 即PS的设计文档1003px*600px，72dpi。 二、文本框设计规范 尺寸大小 (1)小型输入框应至少设置5个中文字符宽度，内边距（padding）上下3px，左右7px，单行不少于18px； (2)大型输入框应至少设置8个中文字符宽度，内边距（padding）上下3px，左右7px，单行不少于18px； (3)搜索框设计宽度至少设置8个中文字符宽度，内边距（padding）上下3px，左右7px，单行不少于18px，宽度不少于130px； 帮助信息 (1)帮助信息一般有二类，限定标签提示、标示性文字等； (2)“限定标签提示”一般放在搜索框的左面； (3)“标示性文字”可设置灰色（#CCCCCC）显示，点击输入框后提示文字消失。提示文字应简明扼要，文字一般用于内容、用途、搜索范围等对用户有真正帮助意义的提示，“请输入关键字”这样的提示不应出现。 1、2、
软件配置项标识编码规则设计方案解读
软件配置项标识编码规则设计方案 刘宏 2011-9-18 Mail:lh@https://www.360docs.net/doc/ed5990916.html, 1.背景 1.1.服务外包中迁移 在服务外包中，难度较大的阶段为——服务外包的迁移工程。 服务迁移工程难度大的主要原因之一，是没有实施迁移前准备标准和迁移后的验收标准。也就是在服务成熟到何种程度——包括管理与技术成熟度，服务才能够向外包方进行迁移，以便发包方有效控制服务外包中的风险，达到服务外包的目的。 服务外包迁移前应达到的准备标准——包括管理标准与技术标准，技术标准是管理标准的基础。技术标准是在服务外包迁移中的必要条件，管理标准是服务外包迁移中的充分条件。 不同服务业务在外包迁移中，具有不同的技术标准，但是具有相同的管理标准——ISO20000规定了管理相关的内容。 因为不同的服务业务具有不同的服务技术标准要求，因此正对IT服务外包业务应根据业务的特点编制相关的技术标准要求。IT服务外包业务可以包括： ●IT系统基础平台维护服务外包 ●IT系统支撑环境维护服务外包 ●应用系统的维护服务外包 1.2.服务外包迁移标准内容 每类服务有可以分成：运营服务（一线服务）、支持性服务（二线服务）、变更性服务（三线服务）。 在IT服务外包中风险较大的是运营服务，因为运营服务一直是直接在客户的生产环境实施，一旦发生错误，有可能给客户造成无法挽回的损失。目前一般风险较大的运营服务，有客户自己承担，不进行外包。 支持性服务也是在客户生产环境实施，但是一般需要进行策划与实施结果测试。由于支
持服务具有一定的技术性，因此这种服务外包迁移前应按照技术标准要求通过验收。只有通过技术标准验收的服务才能够实施服务外包的迁移。 变更性服务是在其他环境中测试完成后，在反映到生产环境中。因此变更性服务与系统建设期的系统开发存在不同的风险。在系统建设期，可以进行充分的测试与试运行测试。在变更性服务由于工期与成本的原因，可能不能充分进行测试与试运行。 1.3.服务外包迁移中标准需求 服务外包方为了及时提供服务需要将分包方的技术成果迁移到外包方处，因此分包方向服务外包方进行服务迁移时，在服务迁移时，迁移哪些内容，迁移的内容在迁移前应到技术标准要求应进行验证与确认。若是没有达到服务外包迁移技术标准，很显然是增加服务外包迁移的风险。 在服务外包迁移实施中，需要对服务外包迁移内容结果进行验证，因此需要服务外包迁移结果验证与确认的技术标准要求。 1.4.应用软件服务迁移标准需求分析 在应用软件系统维护服务外包的迁移中，技术标准主要是针对分包方迁移给外包方的所有技术成果物。对这些成果物需要相关的技术标准要求，以便在服务外包迁移过程，分包方与外包方能够有效沟通与交接，确保服务能够连续，不因为服务外包迁移发生中断或服务水平下降。 为了确保分包方与外包方能够有效进行技术沟通，首先需要明确出工程成果物的标识标准——配置项标识编码标准。这一标准能够是双方能够正确地在配置管理库中找到所需要的配置项。 为了能够有效避免交付过程中，使用错误的成果物。就需要双方共同承认的成果物的编码规则或标准。 由此得出结论：软件配置项标识编码规则，是IT应用系统维护服务外包的技术标准中的基础。 2.方案的目的与目标 2.1.目的 通过提供一般软件配置项编码规则，为企业的软件配置项的管理提供自动化处理的解决
项目编码规范
项目代码编程规范 1.应用范围 本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）JS代码、HTML代码及数据库设计均应遵守这个规范。同时，也可作为其它项目的参考。 2.设计类和方法 2.1. 创建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解，方法是指执行一个独立逻辑的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。 之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。 类应该用来将相关的方法组织在一起。 当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。 大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。 创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。 2.2. 创建松散连接和高度专用的方法 2.2.1.使所有方法都执行专门的任务 每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。 创建专用方法有许多好处。首先调试将变得更加容易。 2.2.2.尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法
软件界面设计要求规范_v0-视觉部分
软件界面设计规范 1概要 界面设计中一定要保持界面的一致性。 一致性既包括使用标准的控件，也指使用相同的信息表现方法，如在字体、标签风格、颜色、术语、显示错误信息等方面确保一致。 界面力求简洁明了，保证系统功能设计的合理与明确，布局明确、交互操作合理、协调统一。功能要表现清楚，分类清晰有条理，避免过多的控件嵌套导致的视觉混乱；单一功能的操作目的明确，符合易用性原则，避免不必要的信息显示而对用户造成视觉干扰；力求操作简单，简单的功能一步完成，比较复杂的功能三步之内，复杂的功能操作使用操作向导来辅助客户完成。 2色调风格 2.1色调： 软件界面设计中常用的主色调包括：蓝色、红色、绿色、黑色 蓝色：运用的行业较为广泛，如通讯、电子、房产、钢铁、生产管理等行业大部分以蓝色为主色调来设计软件。 红色：在政府单位运用比较多。 绿色：一般运用于教育、医疗、农林等行业。 黑色：能源、石油、房地产行业有时候会用中性的黑色作为主色调。
表现区：通常用浅色，如：白色、淡灰、或者淡蓝之类，因为大面积的文字信息在浅色上便于长时间阅读，不容易形成视觉疲劳。 2.2风格： 软件界面的风格通常比较简约。不同行业，使用的环境不同稍有差异。 3登录界面 基本元素：logo、系统名称、输入框、提交按钮。如下： 4页面逻辑结构 功能页面功能页面 弹出页面弹出页面弹出页面
软件界面通常是上面这样的逻辑结构 首页：宏观预览各项设备管理数据，快速访问期望的数据功能 功能页面：查看某一功能模块的全部数据，查看某一对象的各类相关数据 弹出页面：填写和提交表单，对功能中的某一单项数据进行增加/删除/查询/修改/审核/打印/导出等功能操作。 5页面的基本属性 页面宽度：属性值为auto，最小值1024像素。默认状况下无横向滚动条。 注意：宽度、位置、边距为不可变数据 背景：页面整体为白色背景#FFFFFF 或者浅灰、浅蓝等，总之是非常接近白色的颜色。 注：白色为常用色值，对于特殊个性化页面可根据特殊要求变更色彩；背景色彩尽量少用饱和度高的颜色， 页面位置：居中 页面边距：上 0px；下 0px；左 0 px；右 0 px； 注意：有时候会专门设置一定数值的边距，这时通常 与模块间的间距相同，如上下左右都是5px。
工程项目编码规则及管理办法
中船重工船业有限公司工程项目编码规则及管理办法 1. 范围 本办法规定公司各种工程编码分类和编码实施规则及其管理办法。 本规则适用于公司内部所有工程项目的编码计划编制、领发料、财务核算、计算机信息处理等。 2. 工程编码类别及其编制规则说明 2.1工程编码类别分为船舶产品工程、非船产品工程、基建工程、自营工程、设备大修、设备维修、设备技改、安全设施及其它工程。 2.2产品工程编码的编制方法 2.2.1 大吨位运输船舶（千吨位以上）工程号的编制方法 2.2.1.1 编码共6 位。前两位为船舶产品载重吨位或承载体积前两位数；第三位为同载重吨位船舶型号，无型号用0 表示，有型号时分为Ⅰ型、Ⅱ型、Ⅲ型等，分别用1、2、3表示，以此类推；第四、五、六位为公司大吨位运输船舶接单顺序号。 2.2.1.2 图示
例如：公司接单第31 艘70000 吨散货船工程编码为：700031 。 公司接单第18 艘33000 吨散货Ⅰ型船工程编码为：331018 。 2.2.2 商务船工程号的编制办法 2.2.2.1 编码共6位。前两位统一名称为SW（商务）；第三、四两位为商务船的长度，五、六两位为商务船接单顺序号。 2.2.2.2 图示 例如：公司接单第1 艘35 米长的商务船，工程号为：SW3501 2.2.3 小吨位（百吨位）运输船工程号的编制办法 2.2. 3.1 编码共6 位。前两位统一名称为YS（运输）；第三、四两位为运输船的吨位前两位，五、六两位为公司小吨位运输船接单顺序号。 2.2. 3.2 图示 例如：公司接单第1 艘载重吨为20 吨的运输船，工程号：YS2001
软件用户界面设计规范
软件用户界面设计规范 1.导言 1.1 目的 为开发人员提供界面设计和开发的指南，引导开发人员设计简洁美观的用户界面； 1.2 适用范围 适用于xxxxxx。 2.软件界面设计的重要性 2.1 发展趋势 软件用户界面的发展经历了从简单到复杂、从低级到高级的过程，用户界面在软件系统中的价值比重越来越高。 2.2 开发竞争 得益于互联网的发展和普及，软件开发的技术门槛在不断下降，大部分软件企业的技术手段也趋向于雷同，“软件设计”变得越来越重要。当大家都掌握了相似的技术和需求信息后，企业之间的开发竞争“比的就是设计”。 –软件用户界面设计要综合考虑“易用性设计”、“艺术设计”和“技术实现”，很有挑战性。 2.3 用户挑剔 用户界面在很大程度上影响着软件的命运，因为广大用户对软件的评价主要来源于他们操作用户界面的感受。同类软件越多，选择余地越大，购买者对软件
用户界面就越挑剔。 3.软件界面设计的现状、问题及原因 3.1 不容乐观的现状 尽管国内有很多技术出色、聪明过人的软件工程师，但是不少人开发出来的软件产品却既难用又难看，客户很不满意。导致经常要修改软件的用户界面，造成极大的生产力浪费。 到处是用户界面设计缺陷： –界面措辞含糊，甚至有错别字。连简单的消息框都设计不好，可能存在文不对题的语病。 –界面布局混乱，缺乏逻辑，凡是能放的东西都堆集上去，让用户不知从何下手。–没有防错处理，不对用户输入的数据进行检验，不根据用户的权限自动隐藏或者禁用某些功能。执行破坏性的操作之前，不提醒用户确认。 –不提供进度条、动画来反映正在进行的比较耗时间的过程，对于重要的操作也不返回结果，让用户干着急。 3.2 问题和原因之一 由于国内没有开设软件界面设计的课程，大家对这部分知识没有深刻的意识，只是在工作中凭着个人的经验与感觉设计软件的用户界面，这样产生的界面往往得不到大众用户的认可。 3.3 问题及原因之二 开发人员在设计用户界面方面不仅存在先天的教育缺陷，更加糟糕的是还常常“错位”的毛病。他以为只要自己感觉用户界面漂亮、使用起来方便，那么用户也一定会满意。 3.4 问题及原因之三
软件界面设计规范_V1.0 - 视觉部分
软件界面设计规范_V1.0 1概要 界面设计中一定要保持界面的一致性。 一致性既包括使用标准的控件，也指使用相同的信息表现方法，如在字体、标签风格、颜色、术语、显示错误信息等方面确保一致。 界面力求简洁明了，保证系统功能设计的合理与明确，布局明确、交互操作合理、协调统一。功能要表现清楚，分类清晰有条理，避免过多的控件嵌套导致的视觉混乱；单一功能的操作目的明确，符合易用性原则，避免不必要的信息显示而对用户造成视觉干扰；力求操作简单，简单的功能一步完成，比较复杂的功能三步之内，复杂的功能操作使用操作向导来辅助客户完成。 2色调风格 2.1色调： 软件界面设计中常用的主色调包括：蓝色、红色、绿色、黑色 蓝色：运用的行业较为广泛，如通讯、电子、房产、钢铁、生产管理等行业大部分以蓝色为主色调来设计软件。 红色：在政府单位运用比较多。 绿色：一般运用于教育、医疗、农林等行业。 黑色：能源、石油、房地产行业有时候会用中性的黑色作为主色调。 表现区：通常用浅色，如：白色、淡灰、或者淡蓝之类，因为大面积的文字信息在浅色上便于长时间阅读，不容易形成视觉疲劳。
2.2风格： 软件界面的风格通常比较简约。不同行业，使用的环境不同稍有差异。 3登录界面 基本元素：logo、系统名称、输入框、提交按钮。如下： 4页面逻辑结构 软件界面通常是上面这样的逻辑结构 首页：宏观预览各项设备管理数据，快速访问期望的数据功能 功能页面：查看某一功能模块的全部数据，查看某一对象的各类相关数据 弹出页面：填写和提交表单，对功能中的某一单项数据进行增加/删除/查询/修改/审核/打印/导出等功能操作。
软件设计编码规范
质量管理体系过程文件 软件设计编码过程 文件版本信息：
目录 1.目的 设计编码的目的在于设计和实现关于需求的解决方案。保证《需求规格说明书》中的各项要求在设计时都能够得到满足；对项目的编码实现进行质量控制，保证编码实现活动按计划顺利完成并与设计相一致。 2.范围 适用于公司的各类软件项目的系统设计编码过程。 3.术语 无 4.角色与职责
5.入口准则 ●《需求规格说明书》已通过评审。 6.输入 ●《需求规格说明书》 7.流程图 图1: 系统设计编码过程 8.主要活动 系统设计编码过程包括系统设计、系统实现。系统设计是指设计软件系统的体系结构、数据库、模块等，在需求和代码之间建立桥梁，一般分概要设计和详细设计两个阶段；系统实现是指开发人员按照系统设计去编码开发，并进行单元测试、代码走查；在设计编码过程中同时进行用户文档的编制。 8.1.概要设计 概要设计是分析各种设计方案和定义软件体系结构的过程。设计人员在充分了解需求的基础上，依据《需求规格说明书》选用适当的设计方法，分析与设计软件的结构、模块功能。通过系统分解，确定子系统的功能和子系统之间的关系，以及模块的功能和模块之间的关系，编写《概要设计说明书》。《概要设计说明书》必须经过技术评审。 8.1.1.解决方案选择 系统设计时可能会涉及到多种解决方案的选择，如： ●系统实现路线； ●采用的工具和技术； ●产品架构； ●设计模式； ●模块的制作、购买或重用等。 当出现多种候选方案，难以通过简单的方法判断出方案的优劣时，应按照《S_DAR00_决策分析和决定过程》进行决策。
8.1.2.概要设计 概要设计是建立整个软件的体系结构，包括子系统、模块以及相关层次的说明、每一模块的接口定义等。概要设计的主要步骤有： ?选择设计方法； ?识别解决方案的主要组件：根据解决方案的技术架构和分析方法（面向对象、面向结 构），相应确定解决方案的组件模块； ?对候选技术和工具、组件进行评估，确定是进行开发、购买还是复用已有技术（工具 或者组件）。评估开发、购买或复用方案时需要考虑的事项包括：业务方面：可行性、产品成本、经验、投资回报、成熟度及其他因素；企业体系结构方面：解决方案必须 与当前状态和远景状态计划的约束相适应。包括与企业现有系统的集成等；技术方面：安全、组件模块交互标准、数据访问、数据存储、系统服务、开发工具、操作系统等。 ?识别解决方案主要组件的重要属性和关键关系：在前一任务的基础上，对解决方案主 要组件的重要属性和关键关系进行识别； ?进行数据库设计，建立数据库的逻辑模型和物理模型； ?进行用户界面设计，确定整个系统的界面框架以及界面风格； ?形成《概要设计说明书》。 8.1.3.概要设计评审 概要设计的结果应进行技术评审。技术评审由设计人员提出，由项目经理组织召开。技术评审会议应邀请需求分析师、公司的技术专家、开发人员、测试人员等参加。 关于技术评审会议的要求详见《评审过程》。 8.2.详细设计 详细设计可以和概要设计并行进行，但应考虑并行设计不会因概要设计而导致较大的详细设计返工。 8.2.1.详细设计 详细设计是从开发需求的角度描述解决方案的组件、服务和技术的过程。详细设计定义了解决方案的各个组成部分，以及这些组成部分的开发方法和交互方式。详细设计的步骤包括： ?选择用于开发解决方案的技术并完善设计模型：在概要设计的基础上，选择开发解决 方案采用的技术，并且完善对应的设计模型。
软件设计规范
软件设计规范 概述 软件设计是把需求转化为软件系统的最重要的环节，系统设计的优劣在根本上决定了软 件系统的质量。 在此，主要阐述软件系统设计的5个核心内容：体系结构设计、用户界面设计、数据库设计、模块设计、数据结构和算法设计。旨在帮助开发人员搞清楚“设计什么”以及“如何 设计”。 一般把设计过程划分为两个阶段：概要设计阶段和详细设计阶段，如下所示： *概要设计阶段的重点是体系结构设计。 *详细设计阶段的重点是用户界面设计、数据库设计、模块设计、数据结构与算法设计 等。 可根据项目的情况进行文档裁减和过程合并，如项目开发过程只有一个设计阶段和设计 文档。 体系结构 体系结构如同人的骨架。如果某个家伙的骨架是猴子，那么无论怎样喂养和美容，这家 伙始终都是猴子，不会成为人。 由此可见，体系结构乃是系统设计的重中之重。 目前业界比较流行的软件结构模式有C/S（客户/服务器）、B/S（BROWSE/SERVER）、层次结构（上下级层次结构、顺序相邻的层次结构、含中间件的层次结构） 体系结构设计原则 ● 合适性 即体系结构是否适合于软件的“功能性需求”和“非功能性需求”。高水平的设计师高就高在“设计出恰好满足客户需求的软件，并且使开发方和客户方获取最大的利益，而不是 不惜代价设计出最先进的软件。 ● 结构稳定性 详细设计阶段的工作如用户界面设计、数据库设计、模块设计、数据结构与算法设计等等，都是在体系结构确定之后开展的，而编程和测试则是更后面的工作，因此体系结构应在 一定的时间内保持稳定。
软件开发最怕的就是需求变化，但“需求会发生变化”是个无法逃避的现实。人们希望在需求发生变化时，最好只对软件做些皮皮毛毛的修改，可千万别改动软件的体系结构。如果当需求发生变化时，程序员不得不去修改软件的体系结构，那么这个软件的系统设计是失 败的。 高水平的设计师应当能够分析需求文档，判断出哪些需求是稳定不变的，哪些需求是可能变动的。于是根据那些稳定不变的需求设计体系结构，而根据那些可变的需求设计软件的 “可扩展性”。 ● 可扩展性 可扩展性是指软件扩展新功能的容易程度。可扩展性越好，表示软件适应“变化”的能 力越强。 可扩展性越来越重要，这是由现代软件的商业模式决定的： *社会的商业越发达，需求变化就越快。需求变化必将导致修改（或者扩展）软件的功能，现代软件的规模和复杂性要比十年前的大得多（对比一下操作系统的变化就明白了），如果软件的可扩展性比较差的话，那么修改（或者扩展）功能的代价会很高。 *现代软件产品通常采用“增量开发模式”，开发商不断地推出软件产品的新版本，从而不断地获取增值利润。如果软件的可扩展性比较差的话，每次开发新版本的代价就会很高。虽然开发商抓住了商机，但却由于设计水平差而导致没有赚取多少利润，真是要活活气死。 ● 可复用性 由经验可知，通常在一个新系统中，大部分的内容是成熟的，只有小部分内容是创新的。一般地可以相信成熟的东西总是比较可靠的（即具有高质量），而大量成熟的工作可以通过 复用来快速实现（即具有高生产率）。 可复用性是设计出来的，而不是偶然碰到的。要使体系结构具有良好的可复用性，设计师应当分析应用域的共性问题，然后设计出一种通用的体系结构模式，这样的体系结构才可 以被复用。 用户界面设计 为了提高用户界面的易用性和美观程度，总结了十个设计原则。用于提高易用性的界面 设计原则有8个： *用户界面适合于软件的功能 *容易理解 *风格一致
【编号规则】工程信息编码标准
QB ****公司企业标准 信息分类和编码 第3分册工程信息分类和编码 （初稿） 20XX-XX-XX 发布 20XX -XX -XX 发行 *****有限责任公司 发 布 ICS XXX 备案号XXX
目次 前言 (3) 引言 (4) 1范围 (5) 2规范性引用文件 (5) 3术语和定义 (5) 4分类原则和方法 (6) 4.1基本原则 (6) 4.2分类对象的层面划分 (6) 4.3工程信息分类 (7) 4.4工程信息整体框架 (8) 5编码方法 (9) 5.1基本原则 (9) 5.2码值 (9) 5.3代码组结构和层次 (10) 5.3.1交互定位码 (10) 5.3.2项目编码 (10) 5.3.3管理属性编码 (11) 5.3.4设计属性编码 (11) 5.3.5合同属性编码 (12) 5.3.6档案属性编码 (12) 5.3.7采购、财务、招标信息属性编码 (13) 5.3.8非项目信息编码 (13) 6分类与代码表 (14) 6.1非项目信息分类标识码(30301) (14) 6.2省电网公司及直属单位编码(30302) (14) 6.3工程项目建设管理单位代码(30303) (15) 6.4项目属性代码(30304) (18) 6.5综合指标(30305) (19) 6.6立项时间(30306) (20) 6.7批次项目标识码(30307) (21) 6.8信息属性码分类(30308) (21) 6.9项目阶段代码((30309) (22) 6.10工作分解代码(30310) (22) 6.11信息创建部门代码(30311) (23) 6.12设计资料分类代码(30314) (24) 6.13设计阶段代码(30315) (24) 6.14类目代码(30316) (25)
Web界面设计规范方案
Web应用界面设计规范（Design Specific ation for Web UI） 主讲人：ARay 目录： 一、软件界面规范的重要性及其目的 二、用户体验为何如此重要 三、Web规范体系介绍 四、界面设计开发流程 五、应该遵循的基本原则 六、界面设计规范 一、软件界面规范的重要性及其目的 ①使最终设计出来的界面风格一致化，开发编码人员相互之间开发更轻松，遵循统一的操作规范，以标准化的方式设计界面，提高工作效率。减少和改变责任不明，任务不清和由此产生的信息沟通不畅、反复修改、重复劳动、效率低下的现象。 ②产品设计通过规范的方式来达到以用户为中心的目的。 二、用户体验为何如此重要 ①日常生活中的遭遇 X员工悲惨的一天： 早晨起来，发现闹钟没有按原先设定响起来。 一边烧水，一边穿衣服，临走前去喝水却发现水还没有烧开。 到了地铁站，发现公交卡没有钱了。 无奈之下只能去排队买票。 排了3趟地铁，终于到公司了，但是你却迟到了。 结果：尽管你已经非常努力，但是你还是迟到了。 那么，让我们看看这一连串 的倒霉事， 是什么让我们如此狼狈？ ②什么是用户体验
用户体验（user experience）是以用户为中心的设计中最重要的一个部分，强调的是过程，是软件对用户行为产生的反应与用户期待值要尽可能的一致。 糟糕的用户界面表现： 表现一：过分使用各种奇形怪状、五颜六色的控件。 表现二：界面元素比例失调。比如按钮巨大无比，其尺寸甚至超过显示重要内容的文本框的界面。 表现三：界面元素凌乱。比如说，按钮和文本框摆放地点随意，该对齐的控件对不齐。 表现四：违背使用习惯。你按F1，它没有弹出帮助，却执行了一件绝对出乎你意料的动作。表现五：消息框信息含糊、混乱。比如软件弹出一个消息框。把原本“确定”和“取消”写成为“是”和“否”，让用户不知道什么意思。 表现六：还有一种糟糕的用户界面，乍一看很厉害，实际上完全是缺乏规划的结果。这种
软件开发管理规范
软件开发管理规范 Document serial number【KK89K-LLS98YT-SS8CB-SSUT-SST108】
软件开发过程管理规范济南明湖建筑节能技术开发有限公司
一、总则 1.软件开发项目管理的目的 为保障按时、保质、保量完成预期交付的任务，让整个组织能清楚了解项目实施的目的、影响、进度，做到项目组所有成员都理解项目实施的原因、意义及客户的要求。通过制度化管理来合理组织安排项目组成员的工作职责和角色转换。 2.软件开发项目管理规范适用对象 为了达到软件开发项目管理的根本目的，要求公司全体员工必须严格按照本规范执行，同时要求公司业务人员引导合作单位和客户接受并适应公司本《软件项目开发管理规范》。 3.软件项目开发组织管理 根据软件开发的标准流程，结合公司的实际情况对软件项目分三个主要阶段进行组织管理，分别为项目立项阶段、项目实施阶段和项目验收总结阶段。 二、软件项目立项阶段 1.成立公司项目评估委员会负责公司的项目立项审批。 2.公司项目评估委员会由公司总经理或指定负责人召集，成员为公司管 理层人员、商务负责人、市场负责人、技术总监、技术研发经理、财务负责人组成。 3.公司业务部门按照公司发展要求或外部需求形成《软件项目需求说明 书》，确定项目需求管理人或项目申请人。 4.项目申请人填写《软件项目立项申请书》向项目评估委员会提出项目
立项申请，主要说明项目的背景、目的、效益、成本、需求等方面，并由技术部门提供支持和技术说明。 5.项目评估委员会收到《项目立项申请书》后三个工作日内，召开评估 会议。给出评估结果。如果批准立项交公司技术总监组织开发。如果不批准，给出理由后项目中止。中止后的项目可根据情况重新申请。 6.评估结果必须包括：建议项目启动日期，期望项目完成日期，项目等 级系数，项目优先级（高中低），资源冲突程度(1~9)。对于资源冲突程度大于5的项目技术总监有权拒绝接受。 三、软件项目实施阶段 1.公司批准立项的项目交由公司技术总监组织实施。 2.技术总监根据资源情况和项目需求组织相关技术人员进行初步需求讨 论会，确定项目的等级系数（如分大、中、小对应3、2、1）、指定项目开发负责人。在立项后五个工作日内技术总监和项目开发负责人共同制定《软件项目开发计划》，确定项目启动日并提交项目评估委员会做反馈确认。如果项目评估委员会二位成员以上对计划有异议，项目评估委员会应该召开项目计划协调会，协调《软件项目开发计划》的修改和通过。如果无异议授权技术总监按照《软件项目开发计划》执行。 3.项目启动日后，项目开发负责人根据《软件项目开发计划》的进度每 周进行一次分析汇报，形成《项目分析周报》确定项目的状态、分析
软件界面设计规范
软件界面设计规范 1.界面规范 .总体原则以用户为中心。 设计由用户控制的界面，而不是界面控制用户。清楚一致的设计。所有界面的风格保持一致，所有具有相同含义的术语保持一致，且易于理解拥有良好的直觉特征。以用户所熟悉的现实世界事务的抽象来给用户暗示和隐喻，来帮助用户能迅速学会软件的使用。较快的响应速度。简单且美观。 .原则详述 1.2.1.用户控制用户界面设计的一个重要原则是用户应该总是感觉在控制软件而不是感觉被软件所控制。操作上假设是用户--而不是计算机或软件--开始动作。用户扮演主动角色，而不是扮演被动角色。在需要自动执行任务时，要以允许用户进行选择或控制它的方式来实现该自动任务。提供用户自定义设置。因为用户的技能和喜好各不相同，因此他们必须能够个性化界面的某些方面。Windows为用户提供了对许多这方面的访问。您的软件应该反应不同的系统属性--例如颜色、字体或其他选项的用户设置。采取交互式和易于感应的窗口，尽量避免使用模态对话框，而使用"非模式"辅助窗口。"模式"是一种状态，它排除一般的交互，或者限制用户只能进行特定的交互。当最好使用一个模式或该模式只是可替换的设计时--例如，用于在一个绘图程序中选定一个特定感觉--请确保该模式是显然的、可见的，是一个明确的用户选定的结果，并且容易取消。在后台运行长进程时，保持前台式交互。例如，当正在打印一个文档，即使该文档不能被改变，用户也应该可以最小化该窗口。谅解。用户喜欢探索一个界面，并经常从尝试和错误中学习。一个有效的界面允许交互式的发现，它只提供一组合适的选择，并在用户可能破坏系统或数据的情况时发出警告。如果可行，还应提供可逆转或可还原的操作。即使在设计得很好得界面中，用户也可能犯错误。这些错误既可以是物理上得（偶然地指向了错误的命令或数据），也可以是逻辑上的（对选定哪一个命令或哪些数据做出了错误的决定）。有效的设计避免很可能导致错误的情况。它还包容潜在的用户错误，并且使用户易于还原。 1.2.2.清楚一致的设计一致允许用户将已有的知识传递到新的任务中，更快地学习新事物，并将更多的注意力集中在任务上。这是因为他们不必花时间来尝
软件界面设计规范方案
软件界面设计规 1.界面规 1.1.总体原则以用户为中心。 设计由用户控制的界面，而不是界面控制用户。清楚一致的设计。所有界面的风格保持一致，所有具有相同含义的术语保持一致，且易于理解拥有良好的直觉特征。以用户所熟悉的现实世界事务的抽象来给用户暗示和隐喻，来帮助用户能迅速学会软件的使用。较快的响应速度。简单且美观。 1.2.原则详述 1.2.1.用户控制用户界面设计的一个重要原则是用户应该总是感觉在控制软件而不是感觉被软件所控制。操作上假设是用户--而不是计算机或软件--开始动作。用户扮演主动角色，而不是扮演被动角色。在需要自动执行任务时，要以允许用户进行选择或控制它的方式来实现该自动任务。提供用户自定义设置。因为用户的技能和喜好各不相同，因此他们必须能够个性化界面的某些方面。Windows为用户提供了对许多这方面的访问。您的软件应该反应不同的系统属性--例如颜色、字体或其他选项的用户设置。采取交互式和易于感应的窗口，尽量避免使用模态对话框，而使用"非模式"辅助窗口。"模式"是一种状态，它排除一般的交互，或者限制用户只能进行特定的交互。当最好使用一个模式或该模式只是可替换的设计时--例如，用于在一个绘图程序中选定一个特定感觉--请确保该模式是显然的、可见的，是一个明确的用户选定的结果，并且容易取消。在后台运行长进程时，保持前台式交互。例如，当正在打印一个文档，即使该文档不能被改变，用户也应该可以最小化该窗口。谅解。用户喜欢探索一个界面，并经常从尝试和错误中学习。一个有效的界面允许交互式的发现，它只提供一组合适的选择，并在用户可能破坏系统或数据的情况时发出警告。如果可行，还应提供可逆转或可还原的操作。即使在设计得很好得界面中，用户也可能犯错误。这些错误既可以是物理上得（偶然地指向了错误的命令或数据），也可以是逻辑上的（对选定哪一个命令或哪些数据做出了错误的决定）。有效的设计避免很可能导致错误的情况。它还包容潜在的用户错误，并且使用户易于还原。 1.2.2.清楚一致的设计一致允许用户将已有的知识传递到新的任务中，更快地学习新事物，并将更多的注意力集中在任务上。这是因为他们不必花时间来尝
软件设计国家标准
操作手册（G B8567——88） 1引言 编写目的 说明编写这份操作手册的目的，指出预期的读者。 前景 说明： a．这份操作手册所描述的软件系统的名称； b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装该软件的计算中心。 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 参考资料 列出有用的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所列出的这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2软件征述 软件的结构 结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。 程序表 列出本系统内每个程序的标识符、编号和助记名。 文卷表 列出将由本系统引用、建立或更新的每个永久性文卷，说明它们各自的标识符、编号、助记名、存储媒体和存储要求。 3安装与初始化 一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存载形式，安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。 4运行说明 所谓一个运行是指提供一个启动控制信息后，直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程。 运行表 列出每种可能的运行，摘要说明每个运行的目的，指出每个运行各自所执行的程序。 运行步骤 说明从一个运行转向另一个运行以完成整个系统运行的步骤。 运行1（标识符）说明 把运行1的有关信息，以对操作人员为最方便最有用的形式加以说明。 运行控制 列出为本运行所需要”的运行流向控制的说明。 操作信息 给出为操作中心的操作人员和管理人员所需要的信息，如：
项目编码规范编写指南
项目编码规范 1 命名规范 1）.包名采用域后缀倒置的加上自定义的包名，采用小写字母。 在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。 格式： com.huawei.产品名.模块名称 com.huawei.部门名称. 项目名称 示例： Relay模块包名 com.huawei.msg.relay 通用日志模块包名 com.huawei.msg.log 2）. 类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。 示例： OrderInformation, CustomerList, LogManager, LogConfig 3）. 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。 示例： private void calculateRate(); public void addNewOrder(); 4）. 方法中，存取属性的方法采用setter 和 getter方法，动作方法采用动词和动宾结构。格式： get + 非布尔属性名() is + 布尔属性名() set + 属性名() 动词() 动词 + 宾语() 示例： public String getType(); public boolean isFinished(); public void setVisible(boolean); public void show();
public void addKeyListener(Listener); 5）.属性名使用意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。 示例： private customerName; private orderNumber; private smpSession; 6). 常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用 final static 修饰。 示例： public final static int MAX_VALUE = 1000; public final static String DEFAULT_START_DATE = "2001-12-08"; 7). 属性名可以和公有方法参数相同，不能和局部变量相同，引用非静态成员变量时使用 this 引用，引用静态成员变量时使用类名引用。 示例： public class Person { private String name; private static List properties; public void setName (String name) { https://www.360docs.net/doc/ed5990916.html, = name; } public void setProperties (List properties) { Person.properties = properties; } } 8).如果函数名超过15 个字母，可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。 示例： getCustomerInformation() 改为 getCustomerInfo() 2 程序注释规范 1)、基本注释（必须加）