开发技术文档怎么写( 三 )


文档1:《前期调查分析报告》主要内容可以是,进行了什么样的调查;调查的对象;调查的覆盖率;调查的结果 。这个结果得出的结论,和一些建设性意见 。
确定网站主题阶段
文档2:《网站CI形象报告》主要内容主题定位、网站命名、网站标志、标准色彩、标准字体、宣传标语
文档3:《网站目标设计说明书》对网站目标的一个详细说明,其中包括初期目标、中期目标和最终目标 。
确定网站内容和阶段
文档4:《网站访问者来源报告》描述网站的服务对象(文化层次,兴趣爱好,上网条件),估计对象在整个网民中所占的比率 。它是《网站功能分析说明书》的一部分 。
文档5:《网站功能分析说明书》可以描述以下的问题,为什么人们会来你的网站;你的网站有什么特色的服务吗;你们第一次来你的网站原因;有什么可以吸引他们在来的吗?
文档6:《内容和功能清单》明确网站需要什么内容,需要什么功能 。使用目标清单、访问者的需求和竞争性分析这些已经收集的所有信息,开始做两个新的清单:一个是网站的内容要素,一个是网站的功能 。为每个清单增加仍和潜在的页面或内容的类型 。内容的类型包括静态的、动态的、功能的和事物处理的 。浏览竞争对手的网站,把他们有而你没有的内容和功能加入你的清单 。当你建立这两个清单是,让每个人建他们自己的清单,然后把这些清单合并在一起 。让每个人检查一遍合并后的清单,确定清单中每个条目的重要性 。如果有必要的话,修订你的清单 。
文档7:《可视化目录文件清单》
文档8:《网站层次结构图》
4. 软件开发文档应该如何写 模块开发卷宗(GB8567——88)
1标题
软件系统名称和标识符
模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的功能标识代替模块名)
程序编制员签名
卷宗的修改文本序号
修改完成日期
卷宗序号(说明本卷宗在整个卷宗中的序号)
编排日期(说明整个卷宗最近的一次编排日期)
2模块开发情况表
3功能说明
扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出 。可以从系统设计说明书中摘录 。同时列出在软件需求说明书中对这些功能的说明的章、条、款 。
4设计说明
说明本模块(或本组模块)的设计考虑,包括:
a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述,包括本模块在软件系统中所处的层次,它同其他模块的接口;
b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑,包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等;
c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑 。
5原代码清单
要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单 。
6测试说明
说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出 。
7复审的结论
把实际测试的结果,同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论 。
【开发技术文档怎么写】

开发技术文档怎么写

文章插图