设计文档编写规范

《设计文档编写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、深圳市兆日实业有限公司作业指导书文件编号WI4.2-10版本／修改状态B／0标题设计文档编写规范页码第44页43页日期修改状态页码更改说明修改人0新拟制编写陈朝梅、徐阳部门日期2000年10月20日审核部门日期年月日批准部门日期年月日深圳市兆日实业有限公司作业指导书文件编号WI4.2-10版本／修改状态B／0标题设计文档编写规范页码第44页43页深圳市兆日实业有限公司作业指导书文件编号WI4.2-10版本／修改状态B／0标题设计文档编写规范页码第44页43页目录一.项目立项文档编写规范4(1)立项申请报告4(2)可行性研究报告5(3)可行性研究评审报告7(4)产

2、品规格说明书8二．总体方案书编写规范9三．软件设计文档编写规范11(1)软件需求规格说明书11(2)软件概要设计说明书15(3)软件详细设计说明书18(4)通讯协议说明书19(5)函数调用协议说明书20(6)系统对接联调说明书20(7)软件测试计划21(8)软件测试报告23四．硬件设计文档编写规范24(1)硬件需求规格说明书24(2)硬件概要设计说明书25(3)单板硬件概要设计说明书26(4)单板软件概要设计说明书26(5)单板硬件详细设计说明书27(6)单板软件详细设计说明书28(7)单板硬件测试报告29(8)单板软件测试报告30深圳市兆日实业有限公司作业指导

3、书文件编号WI4.2-10版本／修改状态B／0标题设计文档编写规范页码第44页43页(9)硬件系统联调报告30五．结构、包装设计文档编写规范31(1)结构概要设计说明书31(2)结构详细设计说明书31(3)包装详细设计说明书32六．产品移交文档编写规范33(1)生产移交说明书33(3)版本说明及配套表34(3)技术手册35(4)安装手册36(5)用户手册37(6)验收手册37(7)培训手册38七．方案建议书编写规范38八．内部验收文档编写规范39(1)验收测试方案39(2)测试单41(3)验收测试报告42深圳市兆日实业有限公司作业指导书文件编号WI4.2-10版

4、本／修改状态B／0标题设计文档编写规范页码第44页43页一.项目立项文档编写规范(一)规范文档清单①立项申请报告②可行性研究报告③可行性研究评审报告④产品规格说明书(二)规范文档内容(1)立项申请报告本文档用来说明开发项目的主要内容和达到的目标〈主要技术指标〉、经费概算及计划完成时间等。具体编写内容如下:关键词:摘要:缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义。参考资料:列出本文档所引用的参考资料的名称、作者、标题、编号、出版日期、出版单位。1.引言2.项目名称、型号、项目来源、承担部门3.项目的根据及必要性4.国内外技术水平比较

5、和发展趋势5.开发项目的目标和主要技术指标6.研究方向的选择或初步设想的方案和主要技术途径7.需要解决的重大关键技术问题8.工业标准化技术或产品以及公司内成熟技术或产品的利用情况9.关键器材、设备及必要条件10.经济合理性分析和经费深圳市兆日实业有限公司作业指导书文件编号WI4.2-10版本／修改状态B／0标题设计文档编写规范页码第44页43页11.研究进度(起止时间)12.成果形式13.项目负责人及主要成员14.其它15.评审报告预审意见:1.研究方向与公司发展领域的一致性2.关键技术的可实现性3.工业标准化技术或产品以及公司内成熟技术或产品的利用率4.进度、

6、经费合理性5.结论及应采用的开发策略6.审核者姓名，职务或职称及日期7.其它(2)可行性研究报告本文档主要论证开发项目在技术上和经济上实现的可行性、市场可行性以及专利可行性。具体编写内容如下：关键词：摘要：缩略语说明：参考资料：1.引言2.开发目标3.功能、性能及主要技术指标4.国内外现状及发展趋势，分析可能的替代技术或产品所引发的产品生命周期问题。5.技术可行性分析技术可行性分析可包括以下内容：深圳市兆日实业有限公司作业指导书文件编号WI4.2-10版本／修改状态B／0标题设计文档编写规范页码第44页43页l技术关键l技术途径现有公司的技术条件及可供利用共享的

7、程度，可利用合作资源及知识产权现状。l试用方法l风险分析l现有测试条件及设备条件6.市场可行性分析l产品在国内外的销售数量l市场预测的调查和估计l竞争对手情况分析7.人力资源需求情况分阶段提出产品开发各阶段所需各类人员8.经济可行性分析经济可行性分析可包括以下内容：l经济效益估计，包含整个估计的产品生命周期l现有研究设备情况l研究成本估计包括仪器设备费、样机材料费、对外合作费用、产品产生效益后的在开发费用、产品维护等费用及其它人力费用。9.专利可行性分析l专利情报检索、分析（国内、国外）l科技情报及对手技术分析l专利申请策略l制定专利技术合作、许可、借鉴、策略1

8、0.阶段计划确定各阶段的