老黑专用

 
技术文档要求

文档………………………………………………………………………………………………………………… 1
A 用户文档………………………………………………………………………………………………………. 2
A.1 用户手册……………………………………………………………………………………………… 2
A.2 操作手册……………………………………………………………………………………………… 2
A.3 维护修改建议……………………………………………………………………………………….. 2
B 开发文档………………………………………………………………………………………………………. 2
B.1 软件需求（规格）说明书………………………………………………………………………… 2
B.2 数据要求说明书…………………………………………………………………………………….. 3
B.3 概要设计说明书…………………………………………………………………………………….. 3
B.4 详细设计说明书…………………………………………………………………………………….. 3
B.5 可行性研究报告…………………………………………………………………………………….. 3
B.6 项目开发计划……………………………………………………………………………………….. 3
C 管理文档………………………………………………………………………………………………………. 3
C.1 测试计划……………………………………………………………………………………………… 4
C.2 测试报告……………………………………………………………………………………………… 4
C.3 开发进度月报……………………………………………………………………………………….. 4
C.4 开发进度总结……………………………………………………………………………………….. 4

A 用户文档
相关：: 软件需求（规格）说明书
A.1 用户手册

= 本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

A.2 操作手册

= 本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

A.3 维护修改建议
B 开发文档
B.1 软件需求（规格）说明书
相关：: 用户文档

= 也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。 它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

B.2 数据要求说明书

= 该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。

B.3 概要设计说明书

= 该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、 输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

B.4 详细设计说明书

= 着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

B.5 可行性研究报告

= 说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到 [...]

Popularity: 14% [?]

 
Web页面规范建议
（涉及各部门与技术/设计进行沟通及项目合作，非技术/设计部门人员请跳至最后页）

l         导航栏。导航清晰，所有模块保持风格一致。用户可以非常清楚的确认自己所在的位置。
l         要有一个工作良好、使用简易的全站搜索。
l         frame和iframe会产生新的页面进程，不建议使用。

l         不使用图片轮换。首页第一屏重点图片的数量要少。
l         一个时间，最有吸引力的图片只有一张，很多张会导致两个问题：
1、没有重点，不知道哪一张是最重要的，抓不住用户。
2、很大一部分用户不会自行切换图片，图片跳转导致用户心理受挫。

l         文字的字体，粗体、高亮、字体大小的重点。防止次要内容干扰主要内容。
l         图片使用数量的限制，控制装饰性图片对内容的影响。
l         背景图片平铺，注意图片的尺寸。(浏览器对平铺背景的渲染机制有关。)
2*2的图片跟8*8的图片大小差不多，但是平铺背景2*2却占用大很多。

l         给已知宽高的内容图片/Object加上宽度的属性可以减少页面的局部重渲染。（此处是具体的像素尺寸，百分比仍旧会产生重渲染，并有兼容问题。）

l         javascript的使用需要规范化。引入的JS与CSS可以适当合并，同样背景图片也可以合并。

l         flash的使用频度需要控制，同一页面的flash数量尽量少。
flash动得太快对CPU占用很高，控制每秒的帧数及动画的效果可以减少一些，如果把品质用中低显示会省很多资源，但这样却牺牲了效果。quality属性有时选择Autolow 或者Autohigh会更适合，没必要一直low 或者best。
flash使用矢量图会节省文件大小，但计算复杂的图形跟动画时花的是CPU。复杂的太多滤镜，则会占用大量内存。

l         IE的滤镜也是比较占用内存，同时也有兼容性问题。
l         全屏的半透明很吃资源，严格控制使用。

l         ajax的使用虽然可以增强页面表现力，但也影响到部分用户体验。应考虑用户的承受能力。
ajax会使用到xml解释器。ajax是用来减少页面服务器的压力，加快页面展示速度，而不是为了好看。

l         减小被请求文件大小，使用gzip（或类似方式）输出页面。
压缩css、js文件大小，去除缩进、无用空格、空白行、注释等。css使用缩写（见w3c），js使用短变量。

让用户更快的看到想要的结果
l         用户对于一个站点的白页的忍受时间根据统计是8-12秒。白页的产生可能由于各种原因引起,我们能做的就是怎么让用户能变的稍微能等待更久。
方案1：多做一个引导页,让用户体会其中的变化
案例:mail.aol、hotmail等
方案2：优先载入页面结构以及结构图片,后一步载入当前页面数据,再后一步载入Iframe,Flash等数据。让用户尽早的看到被打开页面。

l         让浏览器同时能请求更多的数据。
浏览器默认只是支持单域名同时有两个HTTP请求,使用多域名将能把请求数提高,在网络条件优良的情况下,能更快的下载数据,呈现结果。
把图片、flash、js/css文件存放在不同于web内容服务器的其他服务器上可以有效加快显示速度。

l         提高服务器相应速度（硬件部分，包括线路、服务器性能，负载均衡、镜像等。）
对于需快速响应的文件,把其放入快速响应的服务器。

xhtml+CSS框架：
l         规范代码命名。
在多个站点中可能会用到一些同样的CLASS或ID。有一套完善的css框架，就能对每一个站点的代码进行通读。不用浪费时间在代码的阅读上。

l         更好的团队合作
将一些稍大的站点的前端代码分成若干子项目。要注意公用css，还有注意相互之间的代码配合。如果建立好合适的CSS框架，可以减少很多不必要的错误，提升产品质量和工作效率。

l         解决浏览器的兼容性问题
大部分项目都要求兼容IE6，7和FF。每个站点可能都会花上一部分时间去处理兼容问题。在框架层面上就将这个问题处理好。就可以为后面的兼容问题节省下大部分时间。

l         一套完整的、结构清晰的结构代码。
CSS框架为项目提供一个干净、严谨的基础架构。可以快速的为站点搭建基础的html代码框架。前面的基础工作做好了。后面的开发速度会提高很多。

l         重要内容首先显示，推介、重要的新闻应该先于其他内容显现。广告、菜单等可以稍后显示。

l         各部分内容间分割明显，保持良好的阅读顺序，切忌参差不齐，导航和广告部分建议在主题内容的同一边。

l         尽量不要有过多的拉动滚动条的动作，切忌向上回滚页面。

其他：
l         页面交由GUI设计人员开始设计之前，内容部分必须先行确定，做好内容规划和整体框架布局之后进行设计是必须的。
l         策划人员必须完全确定网站要展示的内容和提供的功能。
l         先做一份十分完善的策划和需求描述，然后建立用例模型、分析网站需求、建立逻辑模型，规划UI模块、规划功能模块、定义UI和功能模块的接口（大多数情况下这个接口就是我们现在经常使用的各种模板标签）、定义 flash应用程序的数据接口（一般情况下是XML文档）、定义内容框架（以便设计师在设计网站时了解网站的每个页面上究竟应该放些什么）。
【先期完善的策划和需求描述文档，可以保证站点内容的一致性。】
  
其他部门向GUI设计人员提交设计需求的建议：
l         列出产品需要的所有视觉元素，包括图标,标志,窗口,按钮等等。
l         给这些视觉元素都草稿出小图案，让GUI设计师明白你想要的。
l         创建层次框架图，如果层次不是特明确的，批注上什么是最重要的。
l         任何视觉限制都要提醒，比如文字大小或者颜色限制。
l         还包括品牌使用规范，限定或者参考。
l         让设计师知道一个好的设计的评判标准。
l         列出所有可能影响到视觉设计的技术限制，比如文件尺寸。
l         一旦你写了文档说明书，附上一到两个样图，然后让GUI设计师出粗略的原型，确保你跟GUI设计师想的是一样的，是同一个评判优秀设计的标准。

完善的前期策划和分析
l         完善的前期逻辑模型以及项目规范性文档的制定。
l         尽可能将行政性干预移到策划阶段。
l         尽可能向后兼容，在项目规范性文档制定阶段对网站进行完善的模块化规范（主要是为了提高网站模块代码的可重用性以及最大程度上降低改版成本）。
l         尽可能简化UI代码的DOM结构，以降低维护成本。
l         在设计和开发过程中首先保证UI的可用性，在此基础上保证其美观。
l         项目阶段明确，在项目的alpha期之前是不可能有能看的懂用的通的完善网站出现的。
l         项目团队主要成员必须要用专业人员，并且要让这些人员有足够的决定权。
Popularity: 15% [?]

Popularity: 15% [?]

做项目流程图、组织结构图、脑图等等。
收费的，不过这个不是问题。-0-
Concept Draw 7
其他产品列表。。
都很贵啊。。
Popularity: 27% [?]

Popularity: 27% [?]

一个简单流程。

Popularity: 10% [?]

Popularity: 10% [?]