[求助]版主请进来!

Lotusm00n

版主:能不能说明一下开发完一个项目后要怎样写"开发手册"和"使用手册"?那里面到底要包括哪些内容?谢谢!

郑瑞城

办公系统开发设计文档(转载)

一、目的和作用

为了使办公系统设计规范化、模块化，便于开发工作的管理，制定此规范文档。
本文档的作用在于使模块的开发者在开发过程中统一开发方法，共享开发经验，统一设计格式，统一使用界面。
本文档包括的内容有：系统总体框架，模块设计开发过程，模块设计规则，系统规则。
二、总体框架

办公系统的各个模块相互独立，通过系统管理模块联系调用。
系统管理模块向其他模块提供各种资料：
使用单位的机构设置：机构名称，上下级关系，职务编制，各种其他资料，如机构的联系电话，联系人，地址等
所有用户的各种情况：用户名称，邮件文件名称，帐号文件名称，所属机构，现任职务，工作编号，及其他资料，如各种联系资料等
所有模块的情况：模块的文件名称，所属服务器名称，标题，版本号等
其他非其他模块特有的，而是多个模块可能都要使用到的资料，如：主题词，
机构情况包括公司情况和机构情况，机构的概念是指公司下属的机构或机构下属的机构的机构
用户若有多种职务，则有多条记录，通过编号来标识同一人，如果编号不同，表示是同名的两个人。
系统管理模块相对于普通用户是透明不可见的，仅系统管理员有权编辑查看，但设计时，此模块上的资料是共享和可以调用的
其他模块在设计中调用上述资料的编程，请参阅内部资料“系统模块说明设计说明书”
三、模块设计开发过程

1.开始设计模块时，首先应明确模块的使用者的身份，模块应提供什么功能，有什么权限

2.填写设计计划书，包括：

模块拥有的角色
第一阶段能设计完成的基本功能：容易设计实现的，用户操作简单的，实现后用户可以使用的功能
第二阶段能设计完成的复杂功能：技术上比较烦琐、复杂，操作使用时可有可无的功能
模块设计需要完成的要素的情况：表单，视图，导航器，或Script库等
设计计划书一般由项目经理填写，是负责安排开发员开发、设计模块的任务指导书
3.照计划完成第一阶段内的功能设计，最后完成时，应是有用户界面，可用的，已经实现了基本功能。

4.第二阶段完善基本模块，排除错误

5.增加新功能，规定时间内，因为技术上的原因，不能实现的功能，隐藏不提供；计划时间内不能完成的功能，下一个版本提供。

6.同时填写设计说明书，应包括：

开发人，时间，
设计计划书中完成的功能，包括设计计划书没有说明的新增功能，不能完成的功能及原因
设计要素：
表单：域、操作、Script等情况
视图：列、操作、公式、Script等情况
导航器：按钮、Script等情况
Script库：创建或使用过的函数库
其他：文件夹、共享域、子表单、Script库等情况
所有的设计要素应是数据库中需要使用的，因为备份等原因临时保存而数据库设计、使用中根本不会使用到的要素，不必包括。
设计模块中的各种经验，心得，创新，技术上的突破等
新增加的子过程，子函数，Script库
设计报告是公司内部保留的，供以后修改模块，以及后续版本的设计的参考资料，一般应由设计员自己填写，也是考察设计员工作情况的一个依据。
7.按照设计计划书和设计说明书填写测试计划，测试模块，填写测试报告，编写使用操作说明书。

测试计划书包括：
测试的模块资料和测试基本资料：测试人，测试时间等
需要测试功能的运行情况，包括正常运行的状态，非法输入运行的状态等的输入值及输出值
在异常状态下的运行情况，如文件打不开，网络中断等
测试报告包括：
测试计划书
记录各种输入值和与计划书有异的输出值，及提供各种可能的原因
记录各种运行操作时，出现错误的操作和提示情况
提出需要改进的地方：如使用界面，操作简便，灵活帮助等。
提出需要新增的功能
测试计划书和测试报告是测试员与开发员传递信息的凭证
如果是由开发员自己测试，则有测试记录，包括进行过的测试，无误和错误解决记录，并应在设计说明书中注明
操作说明书是向用户提供的模块书面帮助，具体格式和应包括的内容请参阅《公共信息数据库操作说明书》
8.整个模块开发完成后，应对内提供：

设计计划书
设计说明书
测试计划书
测试报告
操作说明书
设计原程序
编译后的运行程序
演示程序
四、模块设计规则

1.表单

表单格式，参见图4-1
默认字体：宋体，9号，正常


图4-1

域名称应用英文字母
主表单要用白色背景
2.视图

视图格式，参见图4-2

图4-2

默认字体：宋体，9号，正常
列标题格式：黑色，局中
分类列：红色，左对齐
标题列：黑色
未读文档：红色
交替显示：浅青色
宽度固定的列：不可重新调整大小
其他列：用不同颜色区分
3.导航器

导航器格式

如果按钮很多，且能分类，用图4-3，如果按钮不多，用图4-4
背景色：浅灰色
左上角用简单的图片标识模块，最好注明模块的标题
按钮颜色全为浅灰色
五、系统规则

1.在Notes.ini中应设置的环境变量

$ServerName=系统数据库所在服务器名称
$SystemDatabase=系统数据库文件名称
$WorkDirectory=运行程序所在目录名
2.模块使用的其他变量参数保存在模块自带的配置表单中

3.模块调用的代码，若是特有的，则保存自带的代码表单中，若其他模块可能重复调用，则保存在系统管理模块中，在系统管理模块调用代码的方法，参见附件1“系统管理模块功能介绍”

4.对设计员内部应称模块，对用户则称数据库系统，即在系统操作说明书中只能将数据库，不能提到模块等设计术语

5.模块的版本号格式：

类型号（两位字符）：目前有个人GR，办公BG，信息XX，业务YW
文件名（四位字符）：能区分每个模块的四位英文字符
单位名（四位字符）：能区分模块的使用单位的四位英文字符，如果是“0000”，则为通用版本
提交时间（六位字符）：最后修改时间，年（四位）+月（四位）
例如：XX-GGXX-TPGS-199803，即信息事务，公共信息数据库，供拓普公司使用，1998年4月设计完成
6.序列号和模板名称：

系列号：、
模板名称：如：公文管理

郑瑞城

用户使用手册主要分为：
1 。办公系统安装手册.doc；
2 。办公系统推广模块操作手册.doc（如果有推广模块的话）；
3 。管理员维护手册.doc；
4 。推广配置手册.doc；

DIRL

谢谢！
非常详细！

Lotusm00n

谢谢！

xiupa2

开发手册应该是在项目开发完成之前就写了，一般情况开发手册的完成时间与项目雏形开发完成并完成第一次测试的时间基本相同。

hqma01

/鼓掌/鼓掌