BlogJava-安静的等待-随笔分类-软件测试规范

软件文档知多少

ricki — Mon, 23 Jul 2007 09:03:00 GMT

如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的！”，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确，集数百名员工几年的共同努力之大成，软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤----软件文档。软件文档可以分为开发文档和产品文档两大类。开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。
一、开发文档
1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。
2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节：前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。
3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析(包括客户提出的要求和根据开发经验建议的功能)，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。
4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析(产品的性能和实现方法)，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。
5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。
6. 《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。
7. 《功能函数文档》--包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。
8. 《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。
9. 《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。
10. 《QA文档》--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。
11. 《项目总结》--包括项目简介、项目参与人员和开发时间

ricki 2007-07-23 17:03 发表评论

测试的名词术语

ricki — Mon, 23 Jul 2007 09:01:00 GMT

CMMI标准名词术语

1 AT Assessment Team 评审小组
2 ATM Assessment Team Member 评审小组成员
3 BA Baseline Assessment 基线评审
4 CAR Causal Analysis and Resolution 原因分析与决策
5 CBA CMM-Based Appraisal 基于CMM的评价
6 CBA-IPI
CMM-Based Appraisal for Internal Process
Improvement
为内部过程改进而进行的基于CMM的评价（通常
称为CMM评审）
7 CC Configuration Controller 配置管理员
8 CF Common Feature 公共特性
9 CFPS Certified Function Point Specialist 注册功能点专家
10 CI Configuration Item 配置项
11 CM Configuration Management 配置管理
12 CMM Capability Maturity Model 能力成熟度模型
13 CMMI Capability Maturity Model Integration 能力成熟度集成模型
14 COTS Commerce off the shelf 商业现货供应
15 DAR Decision Analysis and Resolution 决策分析与制定
16 DBD Database Design 数据库设计
17 DD Detailed Design 详细设计
18 DP Data Provider 数据提供者
19 DR Derived Requirement 派生需求
20 EPG Engineering Process Group 工程过程小组
21 FP Function Point 功能点
22 FPA Function Point Analysis 功能点分析
23 FR Functional Requirement 功能性需求
24 GA Gap Analysis 差距分析
25 ID Interface Design 接口设计
26 IFPUG International Function Point Users Group 国际功能点用户组织
27 IPM Integrated Project Management 集成项目管理
28 IR Interface Requirement 接口需求
29 KPA Key Process Area 关键过程域
30 KR Key Requirements 关键需求
31 LA Lead Assessor 主任评审员
32 MA Measurement and Analysis 测量与分析
33 MAT Metrics Advisory Team 度量咨询组
34 MCA Metrics Coordinator and Analyst 度量专员
35 ML matreraty library 度量数据库
36 NFR Non-functional Requirement 非功能性需求
37 OC Operational Concept 操作概念
38 OID Organizational Innovation and Deployment 组织革新与部署
39 OPD Organizational Process definition 组织过程定义
40 OPF Organizational Process focus 组织过程焦点
41 OPL Organizational Process Assets 组织过程财富
42 OPP Organaizational Process Perormance 组织过程性能
43 OSSP Organization’s Set of Standard Process
组织标准过程集合
44 OT Organizational Training 组织级培训
45 PA Process Areas 过程域
46 PAT Process Action Team 过程行动小组
47 PB Process Assets Library 过程财富库
48 PD Preliminary Design 概要设计
49 PDSP Project Defined Standard Processes 项目定义标准过程
50 PI Produce Integration 产品集成
51 PLC Product Life Cycle 产品生命周期
52 PMC Project Monitoring and Control 项目监控
53 PP Project Planning 项目策划
54 PPQA Process and Product Quality Assurance 过程与产品质量保证
55 PPR Price Performance Ratio 性能价格比
56 QA Software Quality Assurance 软件质量保证
57 QA Quality Assurance 质量保证
58 QAP Software Quality Assurance Plan 质量保证计划
59 QPM Quantitative Project Management 量化项目管理
60 RD Requirements Development 需求开发
61 RM/ReqM Requirements Management 需求管理
62 RSKM Risk Management 风险管理
63 RTM Requirement Traceability Matrix 需求跟踪矩阵
64 SAM Supplier Agreement Management. 供应协议管理
65 SC Steering Committee 指导委员会
66 SCAMPI
Standard CMMI Assessment Method for
Process Improvement 过程改进CMMI标准评审方法
67 SCCB Software Configuration Control Board 软件配置管理控制委员会
68 SCM Software Configuration Management 软件配置管理
69 SDP Software Development Plan 软件开发计划
70 SEI Software Engineering Institute (美国)软件工程学院
71 SEPG Software Engineering Process Group 软件工程过程组
72 SPI Software Process Improvement 软件过程改进
73 SPP Software Project Planning 软件项目策划
74 SPTO Software Project Tracking and Oversight 软件项目跟踪与监控
75 SR System Requirements 系统需求
76 SRS Software Requirement Specification 软件需求规格
77 SSM Software Subcontract Management 软件分包管理
78 SSR Software System Requirement 软件系统需求
79 TS Technical Solution 技术解决方案
80 UC Use Case 用例
81 UID User Interface Design 用户界面设计
82 VAL Validation 确认
83 VER Verification 验证
84 WBS Work Breakdown Structure 工作分解结构
85 WP Work Products 工作产品
86 Pre-assessment 预评审
87 Baseline 基线
88 Quality Attribute 质量属性
89 Scenario 场景

ricki 2007-07-23 17:01 发表评论

WCAG1.0与研考会无障碍网页规范对照表

ricki — Thu, 12 Jul 2007 09:50:00 GMT

行政院研究发展考核委员针对网站管理者以及设计者的需要，于九十一年六月「无障碍网页开发标准暨标章核发作业」委外案，参考W3C协会的WAI组织的无障碍网页内容标准相关规范，并参照各国在制订无障碍网页相关政策和推广策略，与国内近年来在身心障碍者保护政策等相关措施，订定我国的「无障碍网页开发规范」，以建立具体的无障碍网络推广目标与策略。

以下为「Web Content Accessibility Guidelines1.0」与「行政院研考会无障碍网页开发规范」的相互对照表。

规范1:  对于听觉及视觉的内容要提供相等的替代文字内容
规范2:  不要单独靠色彩来提供特殊信息
规范3:  适当地使用标记语言和样式窗体
规范4:  阐明自然语言的使用
规范5:  建立编排良好的表格
规范6:  确保网页能在新科技下良好地呈现
规范7:  确保使用者能处理时间敏感内容的改变
规范8:  确保嵌入式使用者接口具有直接可及性
规范9:  设计装置独立网页
规范10: 使用过渡的解决方案
规范11: 使用国际与国内官方订定的技术和规范
规范12: 提供内容导引信息
规范13: 提供清楚的浏览网站机制
规范14: 确保简单清楚的网页内容

规范一: 对于听觉及视觉的内容要提供相等的替代文字内容
检测码
1.1图片需要加上替代文字说明
1.2对于applet提供替代文字说明
1.3对于object提供替代文字说明
1.4对于窗体中的图形按键提供替代文字说明
1.5影像地图区域需要加上替代文字说明
1.6当影像地图使用为上传按钮时，每一作用区域必须分别使用不同的按钮
1.7当alt属性的文字陈述大于150个英文字符时，考虑另外提供文字叙述
1.8提供longdesc以外的描述性超级链接(如D超级链接)，来描述longdesc的内容
1.9图形替代文字陈述不够清晰时，提供更多的文字描述(如使用longdesc属性)
1.10所有语音档案必须有文字旁白
1.11以可及性的影像来替代ASCII文字艺术
1.12视讯中的声音必须提供同步文字型态的旁白
1.13服务器端影像地图中的超级链接必须在网页中有额外对应的文字超级链接
1.14多媒体视觉影像呈现时，必须提供听觉说明
1.15多媒体呈现时，必须同步产生相对应替代的语音或文字说明
1.16客户端影像地图中的超级链接必须在网页中有额外对应的可及性超级链接

规范二:不要单独靠色彩来提供特殊信息
检测码
2.1确保所有藉由颜色所传达出来的讯息，在没有颜色后仍然能够传达出来
2.2确保前景颜色与背景颜色彼此呈现明显的对比

规范三:适当地使用标记语言和样式窗体
检测码
3.1以实际存在的标记语言(如MathML)呈现网页内容(如数学方程式)，避免使用图形影像呈现
3.2确定网页设计檔，有效使用正规的HTML语法
3.3在doctype标签中，使用标准规范的叙述以识别HTML版本类型
3.4尽可能使用样式窗体控制网页排版与内容的呈现
3.5要使用相对尺寸(如%)而非绝对尺寸(如像素)
3.6适当使用巢状标题呈现文件结构
3.7避免使用header标签来产生粗体字效果
3.8项目符号及编号之卷标(如li、ul)仅可使用于实际网页内容的项目条列，不可用于编辑格式
3.9确保q和blockquote标签只是用来当引用语而不是用来缩排
3.10以q及blockquote卷标来标记引用语

规范四:阐明自然语言的使用
检测码
4.1明确地指出网页内容中语言的转换
4.2用abbr及avronym标签表示网页中呈现的文字缩写与简称
4.3明确指出网页文字所使用的自然语言

规范五:建立编排良好的表格
检测码
5.1对于每一个存放数据的表格（不是用来排版），标示出行和列的标题
5.2表格中超过二行/列以上的标题，须以结构化的标记确认彼此间的结构与关系
5.3在网页内容呈现设计时，避免以表格做多

栏文字的设计
5.4若表格只做为版面配置时，勿使用表格之结构标记(如th卷标)作为网页格式视觉效果
5.5表格须提供表格摘要说明(如summary属性)
5.6数据表格须提供标题说明
5.7表格行列过长的标题，须提供缩写或简称

规范六:确保网页能在新科技下良好地呈现
检测码
6.1使用 CSS 样式表编排的文件需确保在除去样式表后仍然能够阅读
6.2页框连结必须是HTML档案
6.3使用Script语言需指定不支持Script时的办法
6.4若网页内的程序对象没有作用时，确保网页内容仍然可以传达
6.5若网页对象使用事件驱动时，确定勿仅使用鼠标操作
6.6使用页框时要指定不支持页框时的办法

规范七:确保使用者能处理时间敏感内容的改变
检测码
7.1确保网页设计不会致使屏幕快速闪烁
7.2避免使用blink卷标闪烁屏幕
7.3避免使用marquee卷标移动文字
7.4避免使用动态gif图片
7.5不要让网页每隔一段时间自动更新
7.6不要自动转移网页的网址

规范八:确保嵌入式使用者接口具有直接可及性
检测码
8.1对由Scripts、Applets及Objects所产生之信息，提供可及性替代方式

规范九:设计装置独立网页
检测码
9.1尽量使用客户端影像地图替代服务器端影像地图连结
9.2对所有网页内容元素，确保有鼠标以外的操作接口
9.3确保事件的启发不要求一定得使用鼠标
9.4具体指出按下Tab键在窗体控件，超级链接及对象间移动的顺序
9.5对经常使用的超级链接，增加快速键的操作
9.6对于窗体组件考虑提供键盘快速键的操作

规范十:使用过渡的解决方案
检测码

10.1除非使用者知道将会开启一个新窗口，不要随便开启一个新窗口
10.2如果使用Script语言开启新窗口或改变目前窗口的网址，要让使用者能事先知道
10.3确保窗体的控件与控件说明之间的配合很适当
10.4若有以表格直栏格式呈现的网页文字内容时，提供线性文字替代
10.5在网页文字输入区中须有默认值
10.6勿单以空白间隔分开相连之超级链接

规范十一:使用国际与国内官方订定的技术和规范
检测码

11.1如果你不能使这个网页无障碍化，提供另一个相等的无障碍网页
11.2尽量使用开放性的最新国际标准规范
11.3避免使用过时的HTML语法
11.4允许使用者依照个人喜好设定网页呈现方式与内容

规范十二:提供内容导引信息
检测码

12.1需要定义每个页框的名称
12.2如果页框名称无法描述页框中的内容的话，应加上额外叙述
12.3把太长的选单项目群组起来
12.4在窗体控件中，使用fieldset及legend标签作群组间的区隔
12.5尽可能将网页内容有相关之元素聚集在一起
12.6在窗体控件上，以label卷标提示信息

规范十三:提供清楚的浏览网站机制
检测码
13.1设计并确保有意义的超级链接说明，便于网页内容的阅读
13.2如果需要的话，为每个超级链接加上内容描述
13.3指向不同网址的超级链接，不可使用相同的超级链接说明
13.4使用metadata卷标来记载计算机可以了解运用的网页信息
13.5为你的网页加上标题
13.6为你的网站提供网站地图或整体性的简介
13.7网页设计使用清楚且一致的导览机制
13.8提供网页导览连结工具列，以利存取网站导览结构
13.9能辨别出意义上有群组相关的超级链接
13.10若有群组超级链接，在群组之前增设一项绕过此区域的超级链接
13.11若网站具有搜寻功能，可以设计不同的网页内容搜寻方式，以提供不同技能与喜好者搜寻选用
13.12在网页标题、段落、及列表之前，提供辨别讯息以利识别
13.13以metadata标签来识别网页文件包含于整体文件内的所在位置
13.14：H313213 避免在网页上使用ACSII文字艺术

规范十四:确保简单清楚的网页内容
检测码

14.1网页内容要使用简单易懂的文字
14.2使用可及性的图形促进网页内容的理解
14.3网页彼此间设计呈现的风格要一致

ricki 2007-07-12 17:50 发表评论