1. 文档类型选择
软件使用说明书:较为常用,需详细描述软件的功能、操作流程、使用方法等内容。例如,一款图像处理软件的使用说明书,应涵盖从软件启动、导入图片、各种处理功能(如裁剪、调色、滤镜应用等)的操作步骤,到最终保存图片的全过程。要让普通用户通过阅读该说明书,能够顺利使用软件。
软件设计说明书:着重阐述软件的架构设计、模块划分、接口设计、数据库设计等。以一个电商平台软件为例,软件设计说明书需说明前端界面与后端服务器的架构关系,用户模块、商品模块、订单模块等的功能及相互之间的数据交互,以及数据库中各类数据表的设计结构和关联关系。
软件总体设计文档:从宏观角度描述软件的整体规划,包括软件的目标、适用范围、总体架构、技术选型等。如一款移动办公软件的总体设计文档,需明确软件旨在提高企业办公效率,适用于各类企业用户,采用微服务架构,选用某种移动开发框架和后端编程语言等。
2. 内容要求
完整性:文档应全面覆盖软件的各个方面。无论是选择哪种文档类型,都要确保软件的功能、特性、操作、设计等关键信息无遗漏。例如,在软件使用说明书中,不能只介绍主要功能,而忽略一些辅助功能或特殊情况下的操作方法;软件设计说明书中,各个模块的设计细节和相互关系都要阐述清楚。
准确性:文档中的描述必须与软件实际情况精准匹配。比如,操作步骤要与软件界面的实际布局和功能按钮完全一致;软件设计说明书中的架构和模块设计要真实反映软件的实际代码结构。若软件在某个版本中对某个功能进行了修改,文档内容也应及时更新,保持与当前软件版本的一致性。
清晰性:使用简洁明了、通俗易懂的语言编写文档,避免使用过于专业或生僻的术语。对于复杂的操作流程或技术概念,要通过举例、图示等方式进行解释说明。如在介绍软件的某个复杂算法时,可以用简单的示例数据和步骤来演示算法的
行过程;在描述软件的操作步骤时,配合软件界面截图,让阅读者能够一目了然。
3. 格式规范
纸张规格:采用 A4 纸张。
页面布局:纵向排版,文字从左向右排列。页边距可设置为上、下、左、右均为 2.5 厘米,以保证页面美观且便于阅读和装订。
字体字号:一般使用宋体小四号字,标题可适当加大字号并加粗,以区分正文内容。例如,一级标题用三号黑体加粗,二级标题用小三号楷体加粗等。
行距:设置为 1.5 倍行距,段落间距可根据实际情况适当调整,以增强文档的可读性。
页码标注:在文档每页的底部居中位置标注页码,从 1 开始连续编号。
4. 行数要求
除有图的页面外,文档每页不少于 30 行。这是为了保证文档内容的充实性和完整性,避免出现大量空白页面或内容过于稀疏的情况。例如,在软件使用说明书中,如果某一页主要是软件界面截图,那么文字说明部分应尽量保证达到行数要求;若某一页全是文字内容,则需合理排版,确保行数符合规定。
5. 提交份数及特殊情况处理
提交份数:一般情况下,需提交一份完整的软件创作文档。
文档篇幅:如果文档总页数不足 60 页,需提交全部文档;若文档超过 60 页,则需提交前 30 页和后 30 页。这是因为在软件著作权登记审查过程中,审查人员主要通过这部分内容来了解软件的相关信息。例如,一份长达 80 页的软件设计说明书,只需提交前 30 页和后 30 页即可,但要确保这 60 页能够充分体现软件的核心设计和关键信息。