2013级《软件文档写作》大作业提交要求-2016.4
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
《软件文档写作》大作业提交要求
一、总体说明
各小组请严格参照qq群中压缩包的目录结构和内容,提交大作业的电子版(指定格式的压缩包)、打印稿(指定次序装订好、黑白打印即可)。
其中html 文件在用户使用说明书中已经有截图,不用打印,只需要提供电子稿。
各小组的黑白打印稿左侧装订,请不要用夹子,以免散落,装订次序自上而下:组内分工表、可行性研究报告及评审表、需求分析说明与概要设计书及评审表、详细设计式样书及评审表、用户使用说明书及评审表、Q&A一览表、bug 一览表、进度管理表。
电子版的目录结构如下图1、图2所示。
图1 作业电子版目录结构
图2 管理文档组成
除了《可行研究报告》word文件的目录结构自由发挥,《用户使用说明》ppt 文件的底版和内容自由发挥之外,其它文档全部参照给定格式的demo撰写。
所有word文档必须有封皮,注明文档名称、班级、团队名称、系统名称和
成员信息;还必须有目录;能正确显示“文档结构图”;奇数页眉以“班级-团队-系统名”格式显示,偶数页眉显示文档名称,封皮不显示页眉;页脚以“第x 页/共x页”形式居中显示正文页码,封皮和目录不计算在页码范围内,正文从第1页开始。
所有excel文件,必须有封皮,注明文档名称、班级、团队名称、系统名称和成员信息;请严格按照格式填写;表格所有边界线完整、清晰,并且自行查看“打印预览”效果,设置成可以整页完整打印。
二、开发文档
1.可行性研究报告
(整个团队一个word文件)
2.需求分析说明与概要设计书
(整个团队一个word文件)
3. html页面设计文件
(小组内每人至少1个页面)
4.详细设计式样书
(每人一个excel文件。
)
三、用户文档
1.用户使用说明书(整个团队一个ppt文件)
必须包含所有完成的html页面的操作使用说明(截图+文字说明)。
Ppt第一页为封皮,最后一页为结束页。
封皮上需要注明:文件名(xx系统用户使用说明书)、班级、
团队名称、系统名称、团队成员(组长名字用*标识)。
包含系统使用总体说明,要求自行设计ppt底板,不能使用模板的ppt底板。
要求包含动画、目录、页面切换方式、页码、超级链接。
(为了节约,Ppt可以4页或6页合并打印。
其他文档单页内容较多,都单页打印。
ppt合并打印方法的图示如下图3所示。
)
四、管理文档
1.Q&A一览表(整个团队一个excel文件,每个同学至少写2条。
)
2.bug一览表(整个团队一个excel文件,每个同学至少写2条。
)
3.进度管理表(整个团队一个excel文件)
4.评审表(每个评审表中,小组内每人至少写2条)
(1)可行性研究报告评审表
(2)需求分析说明与概要设计书评审表
(3)详细设计式样书评审表
(4)用户使用说明书评审表。