软件文档编写规范与工程化研究

一、总体目标

软件盛行的时代，用户的需求复杂多变，为了满足用户的需求，各种各样的软件数量日益增多。但随着软件工作环境（硬件系统或系统软件的升级换代）变化，软件只重视开发而忽略维护，引发了软件危机。软件危机的表现主要是用户需求不满足、软件质量差、成本和进度不准确，可维护性差，文档不完整、不合格等。为了更好地解决软件危机，让软件开发规范化和工程化，软件文档起着举足轻重的作用，所以很有必要重视软件生存周期（计划、开发、运行）软件文档的编写，它是软件开发的关键环节。

二、选题范围及其研究内容

工程文档写作范围：

1. 综合服务类系统文档书
2. 信息查询类系统文档书
3. OA系统文档书
4. 本科教务管理系统文档书
5. 某行业或某企业信息化系统文档书

工程文档写作内容

内容包括但不限于项目立项阶段文档、需求分析书、概要设计书、详细设计书、项目验收总结报告。

三、要求

(1) 参照学术论文格式进行撰写，格式要求如下：

• 论文题目（黑体，小三）
• 摘要（宋体5号加粗）摘要内容（楷体五号）
• 关键词（宋体5号加粗）关键词内容（楷体五号）
• 论文标题（小四号，宋体加粗，行间距1.25倍）
• 论文正文（中文：宋体五号；英文：Times New Roman 五号，行间距1.25倍）
• 图表（中文：宋体小五号；英文：Times New Roman 小五号）
• 参考文献（小四号，宋体加粗，行间距1.25倍）
• 参文文献清单（中文：宋体五号；英文：Times New Roman 五号）

(2) 每个文档页数不少于8页；

(3) 文档前面加上封面，封面格式参见附件。内容：

(4) 文档内容严格按照选题范围和研究内容进行书写，内容要全面、准确、具体，数据真实可靠；

(5) 语言清晰、简练，逻辑严密，层次分明，表述准确，不出现错别字、语病等问题；

(6) 参考文献必须符合规范，引用部分必须注明出处，不得抄袭、剽窃他人成果；

(7) 文档排版整齐美观，表格、图表规范，字体大小、行距等要符合规范要求；

(8) 在规定时间内完成文档的撰写和提交。