做软件项目设计文档怎么写啊

中国版权保护中心接收登记的文档包含两种：操作说明书或设计说明书。

设计说明书适合没有界面的嵌入式软件，插件软件，后台运行软件以及游戏软件。一般包含结构图，软件流程图，函数说明，模块说明，数据接口，出错设计等。

操作说明书适合管理类软件，有操作界面，一般应包含登录界面，主界面，功能界面截图，截图之间有相应的文字说明，能全面展示软件的主要功能。

格式要求：

一、说明书应提交前、后各连续30页，不足60页的，应当全部提交。

二、说明书页眉应标注软件的名称和版本号，应当与申请表中名称完全一致，页眉右上应标注页码，说明书每页不少于30行，有图除外，另外截图应该清晰完整。

(1)引言

①编写目的：阐明编写手册的目的，指明读者对象。

②项目背景：说明项目的来源、委托单位、开发单位及主管部门。

③定义：列出手册中用到的专门术语定义和缩写词的原意。

④参考资料：列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。

包括项目的计划任务书，合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；测试计划；手册中引用的其他资料、采用的软件工程标准或软件工程规范。

(2)软件概述

①目标。

②功能。

③性能。包括数据精确度(包括输入、输出及处理数据的精度)，时间特性(如响应时间、处理时间、数据传输时问等)，灵活性(在操作方式、运行环境需做某些变更时软件的适应能力)。

(3)运行环境

①硬件：列出软件系统运行时所需的硬件最小配置，如计算机型号、主存容量；外存储器、媒体、记录格式、设备型号及数量；输入、输出设备；数据传输设备及数据转换设备的型号及数量。

②支持软件：操作系统名称及版本号；语言编译系统的名称及版本号；数据库管理系统的名称及版本号；其他必要的支持软件。

(4)使用说明

①安装和初始化：给出程序的存储形式、操作命令、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件开发工具等。

②输入：给出输入数据或参数的要求。

③输出：给出每项输出数据的说明。

④出错和恢复：出错信息及其含义、用户应采取的措施，如修改、恢复、再启动等。

⑤求助查询：说明如何操作。

(5)运行说明

①运行表：列出每种可能的运行情况，说明其运行目的。

②运行步骤：按顺序说明每种运行的步骤，应包括运行控制；操作信息(运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项)；输入/输出文件(给出建立和更新文件的有关信息。

如文件的名称及编号、记录媒体、存留的目录、文件的支配[说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密控制等])；启动或恢复过程。

(6)非常规过程：提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。

(7)操作命令一览表：按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

(8)程序文件(或命令文件)和数据文件一览表：按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

(9)用户操作举例。

根据软件工程的要求，在软件设计制作过程中，会形成多个文档。整个过程一般会包括，用户需求报告、软件设计说明书、软件模块分析、软件模块设计和检测、软件整体统调和测试、生成用户操作手册等。

根据软件著作权登记的要求，这些过程中形成的对软件本身起说明性作用的文档，均可以作为软件著作权登记中的文档提交。一般会提交设计说明书或者操作手册（即用户手册）。

所以，编写方法可以参见软件工程的相关教材。

在具体实践中可以按下列提纲撰写内容：

1．引言

1.1编写目的

[说明编写这份概要设计说明书的目的，指出预期的读者。]

1.2背景

a.[待开发软件系统的名称；]

b.[列出本项目的任务提出者、开发者、用户。]

1.3定义

[列出本文件中用到的专门术语的定义和外文首字母组词的原词组。]

1.4参考资料

[列出有关的参考资料。]

2．总体设计

2.1需求规定

[说明对本系统的主要的输入输出项目、处理的功能性能要求。包括]

2.1.1系统功能

2.1.2系统性能

2.1.2.1精度

2.1.2.2时间特性要求

2.1.2.3可靠性

2.1.2.4灵活性

2.1.3输入输出要求

2.1.4数据管理能力要求

2.1.5故障处理要求

2.1.6其他专门要求

2.2运行环境

[简要地说明对本系统的运行环境的规定。]

2.2.1设备

[列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能。]

2.2.2支持软件

[列出支持软件，包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。]

2.2.3接口

[说明该系统同其他系统之间的接口、数据通信协议等]

2.2.4控制

[说明控制该系统的运行的方法和控制信号，并说明这些控制信号的来源。]

2.3基本设计概念和处理流程

[说明本系统的基本设计概念和处理流程，尽量使用图表的形式。]

2.4结构

[给出系统结构总体框图（包括软件、硬件结构框图），说明本系统的各模块的划分，扼要说明每个系统模块的标识符和功能，分层次地给出各模块之间的控制与被控制关系。]

2.5功能需求与系统模块的关系

[本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。]

2.6人工处理过程

[说明在本系统的工作过程中不得不包含的人工处理过程。]

2.7尚未解决的问题

[说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。]

3．接口设计

3.1用户接口

[说明将向用户提供的命令和它们的语法结构，以及相应的回答信息。]

[说明提供给用户操作的硬件控制面板的定义。]

3.2外部接口

[说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持系统之间的接口关系。]

3.3内部接口

[说明本系统之内的各个系统元素之间的接口的安排。]

4．运行设计

4.1运行模块组合

[说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块的支持软件。]

4.2运行控制

[说明每一种外界的运行控制的方式方法和操作步骤。]

4.3运行时间

[说明每种运行模块组合将占用各种资源的时间。]

5．系统数据结构设计

[不涉及软件设计可不包含]

5.1逻辑结构设计要点

[给出本系统内软件所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。]

5.2物理结构设计要点

[给出本系统内软件所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系、设计考虑和保密条件。]

5.3数据结构与程序的关系

[说明各个数据结构与访问这些数据结构的各个程序之间的对应关系。]

6．系统出错处理设计

6.1出错信息

[用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。]

6.2补救措施

[说明故障出现后可能采取的变通措施。]

6.3系统维护设计

[说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。]