软件文档写作

软件文档写作（共5篇）

软件文档写作 篇1

办公软件是一类应用广泛的基础软件，用于对文档信息的处理。文档格式是关于文档信息逻辑结构和物理存储结构的定义，是办公软件文档信息交换的重要基础。目前，办公软件的文档格式主要有三项标准，分别是我国国家标准“标文通”(GB/T20916，也称UOF)[1]，国际标准ODF (ISO/IEC26300)[2]和OOXML (ISO/IEC 29500)[3]。

随着“核高基”科技重大专项“办公软件文档格式标准研制与测试”课题的实施以及“标文通”制修订计划项目的立项，我国将启动对“标文通”的修订工作。为了确定“标文通”修订工作在专利和知识产权方面的工作策略，需要检索、统计和分析文档格式相关的专利，并分析其对“标文通”系列标准研制和实现的影响。

1 技术路线

专利分析的技术路线如图1所示。

专利分析工作分为四个阶段：方案论证阶段、专利检索阶段、专利分析阶段和形成报告阶段。

(1）方案论证阶段

科学的检索方案是保证检索结果全面性和准确性的重要保障，为保证查全性和查准性，课题组与专业的专利检索机构共同制定检索方案，并组织专家对检索方案进行论证。

(2）专利检索阶段

专利检索严格按照检索方案进行，按照IPC分类号和关键词筛选进行专利检索。为确保查全性和查准性，采用背对背双查方案，相互验证。

(3）专利分析阶段

专利检索仅获取了目标专利，建立了专利库。尚需深入分析专利对文档格式标准研制及产品实现的影响。为保证专利分析的科学性和客观性，组织办公软件厂商对专利进行综合分析，并根据每个厂商的技术路线进行针对性分析。

(4）形成报告阶段

通过专利分析形成了分析报告草案，为保证分析报告的权威性，引入第三方评审。通过向第三方征求意见、组织专家评审进一步完善分析报告，形成最终的分析报告。

2 专利检索

2.1 专利检索方法

文档格式专利检索方法如图2所示。

对办公软件文档格式相关专利的检索采用了关键词和国际专利分类号(IPC)相结合的方式进行。在中文库的检索中，以文档、XML、文档格式、文档处理等为关键词，结合国际分类号G06F17/21、G06F17/24、G06F17/20、G06F17/30、G06F9/45、G06F9/44，并以申请人为入口对中文文献进行补检，经过数据筛选、处理后最终得到相关专利文献。

同时，为保证办公软件专利服务项目检索数据的全面性、准确性，对第一阶段检索结果，通过相关引文数据进行扩展，包括发明人引文数据及审查员引文数据。通过第一阶段检索到相关度较高的中英文专利文献，对其中的发明人引文及审查员引文数据进行深度标引，提取出中文专利文献中的发明人引文和审查员引文中的相关专利数据。

对检索得到的中文和外文数据进行处理，包括去重、筛选、同族处理、摘要整理等。

2.2 专利检索目标

本次专利分析的检索目标是办公软件三大应用(文字处理Word Processing、电子表格Spreadsheet、演示文稿Presentation)的文档格式和功能实现相关的专利，特别是与微软、IBM、Sun公司相关的专利，以及与基于XML的文档处理相关的专利。专利检索所涉及的专利限于2010年之前申请的专利，其中部分2008年、2009年申请但尚未公开的专利不在检索范围内。

2.3 专利检索数据源

针对上述检索目标，课题组咨询了专利检索领域的专家，确定采用中国专利文献数据库(CPRS)作为检索中文专利的数据源，采用欧洲专利局专利文献数据库(EPODOC)及德温特世界专利索引数据库(WPI)作为检索英文专利的数据源。

2.4 中文库检索

(1）按分类号检索

本次专利检索所关注的主要分类号包括：G06F17/21、G06F17/24、G06F17/20等。

(2）按关键词检索

本次专利检索所关注的主要关键词包括：办公软件、文档、格式等。

(3）按申请人机构代码检索

本次专利检索所关注的主要组织机构代码包括：Microsoft、IBM、SUN、金山和永中科技。

2.5 外文库检索

在外文数据库的检索中，采用关键词结合国际分类号、关键词结合申请人、国际分类号结合申请人的检索策略，以XML+Microsoft/IBM/Sun Microsystems、G06F17/24+Microsoft/IBM/Sun Microsystems、G06F17/21+Microsoft/IBM/Sun Microsystems等作为检索式进行检索，并采用其他检索方式进行补检，进行数据筛选、过滤处理之后最终得到相关专利文献。

2.6 专利检索结果

经对中国专利数据库及国外专利数据库的检索，得到与办公软件相关的专利3 154项，其中Microsoft、IBM、SUN三家公司专利数分别是1 019项、1 212项、197项，占总数的77，占据着主要申请人的地位。另外，检索结果中2 800项专利在国外申请、354项专利在国内申请，国内申请的专利中多数为外国企业在中国申请，本土企业及科研机构申请数量极少，不足1。

3 专利分析

3.1 专利分析方法

专利分析主要包括两种方法，分别是专利统计分析和专利技术分析。专利统计分析主要对专利库中的数据进行专利现状统计，形成申请量统计等状态图。专利技术分析主要通过技术专家对各条专利的摘要及全文进行技术研究，将专利映射到文档格式、产品实现及文档处理几大分类的各个子类，并分析该专利对标准研制或产品实现的具体影响。

3.2 专利统计分析

本次专利分析主要从分类号统计排序、国别统计排序、专利权人统计排序、年度申请量统计、国别-年度申请量统计、专利权人-年度申请量统计、国别(中国)-专利权人统计和国别(中国)-年度申请量统计等八个维度进行统计分析。限于篇幅，下面仅给出三个统计分析图。

图3展示了Microsoft、IBM、SUN在国际专利分类号IPC G06F17/21、G06F17/24、G06F17/20、G06F17/30、G06F9/45、G06F9/44下的专利申请对照图。

图4展示了2000年以来历年办公软件文档格式领域专利申请量，可见2005年达到峰值。从图4中可以看出，2005年左右国内外办公软件文档格式领域的技术研究水平达到了成熟阶段，之后该领域的专利申请量呈现缓慢增长的趋势。由于专利申请通常是在18个月之后公布，因此专利申请量的统计存在年度误差。但可以肯定的是，随着新技术的不断发展和用户的不断需求，办公软件文档格式领域的专利申请仍将保持快速增长。

图5展示了2000年以来历年Microsoft、IBM、利申请图。从图5中可以看出，相比而言，IBM的申请量呈现行业领先趋势，仅在2004～2007年Microsoft申请量超越了IBM。SUN申请量相对较少。

3.3 专利技术分析

为了深入进行技术分析，需要将检出的专利映射到文档格式相关的技术领域。本次分析主要将专利映射到置标语言处理、文字处理、电子表格、演示文稿、图形、办公软件界面和办公软件存储等七个领域。下面以文字处理领域为例，给出技术分析结果。

3.3.1 功能分析

文字处理作为文档编辑和排版软件，主要用于编辑文字图形、图像、声音、动画，还可以插入其他软件制作的信息，也可以进行图形制作、编辑艺术字、数学公式等各种文档处理要求。文字处理的功能如下：

(1)具有中英文输入、编辑、排版和打印等功能;

(2)创建“所见即所得”的文档;并提供字符和段落的字体、大小、颜色、左对齐、右对齐、居中对齐、两端对齐、横排与竖排、段落间距设置等多种格式编辑功能;

(3)具有图文混排功能;

(4)在文档中设置项目符号、段落名称和项目或段落的数字编号，并具备自动更新功能;

(5)提供表格、自选图形、艺术字和商业图表功能;

(6)在文档中插入域的功能;

(7)在文档中设置书签和插入超链接的功能;

(8)在文档中插入注释、脚注和尾注;

(9)生成索引与目录;文字处理可以根据各种特殊标记，自动生成文档的目录和索引;

(10)提供文档保护，提高了文件的安全性;

(11)提供稿纸、信笺的编辑和打印功能，满足中国人特有的写作需求。

3.3.2 专利分析

数据源中文字处理相关专利198项，主要包括编辑方法、文档布局、文档管理、字体字符处理、拼写纠错、文本或图形信息获取与识别、格式转换等方面，其中英文专利163项，中文专利35项，按照申请年限分布如表1所示，对办公软件实现的影响级别如表2所示。

本次专利分析检索了与办公软件三大应用(包括文档格式和功能实现)相关的2010年前申请的专利，检索的数据源包括中国专利文献数据库、欧洲专利局专利文献数据库及德温特世界专利索引数据库，共检出3 154项专利。通过对检出专利的分析可以看出：(1) Microsoft、IBM和Sun公司在办公软件领域的专利申请中占据着较大份额;(2)我国办公软件企业及科研机构在办公软件领域中申请的专利较少，需进一步加强;(3)大部分专利与文档格式标准无直接联系，专利主要集中于功能实现的方法上;(4)随着Web Office的兴起，会出现新一轮专利申请高峰期，需密切关注该领域的专利申请。

摘要：为确定“标文通”修订工作在专利方面的工作策略, 需检索办公软件文档格式相关的专利, 并分析其对“标文通”修订工作的影响, 阐述了办公软件专利分析的四阶段技术路线, 并重点分析了专利检索和专利分析的技术方案和实施方法。

关键词：办公软件,文档格式,标文通,专利,专利检索,专利分析

软件文档写作 篇2

1． 请各小组认真分析并讨论，明确《可行性研究报告》中各部分

应该撰写的内容；

2． 独立完成《可行性研究报告》；

3． 注意排版，不要有错别字。所打印的报告小心装订在报告册中，不要超出报告册的大小范围。

4． 参照后面所提供的模板（附录2）《可行性研究报告》的排版。

5． 报告册封面的内容请填写完整，如下：

专业：软件工程（软件测试）

班级：2008－1

姓名：×××

课程名称：软件文档写作

教师：任慧琴

学期：2010－2011学年第一学期

6． 报告册内容按附录1填写完成附录1.上机报告册内容填写模板：

实验题目：

系统可行性研究报告的编写

实验目的：

针对系统进行分析与讨论，掌握可行性研究报告的编写技能。

实验要求：

参考《软件产品开发文件编制指南》（GB8567—1988）中《可行性研究报告》编写指南，完成系统可行性研究报告的编写。

实验设计：

你所要完成的案例的具体内容抄写在此。

以及打印的出来的，与报告册同等大小的，完整的一份可行性研究报告。

附录2.《可行性研究报告》排版模板：

（封面部分）

文档编号：WD_AirlineReserv_FS_101203

(文档标号由“文档字母标志WD_软件项目名称AirlineReserv_文档类型FS_文档生成日期101203”组成)版本号：V1.0

可行性分析报告

项目名称：机票预定系统项目负责人：***项目开发单位： 华东交通大学软件学院

2010年12月3号

目录

（生成你的文档目录）

（以下是正文部分）

一、引言（黑体，小三号）1.编写目的（楷体，小三号，加粗）

本文档主要对机票预定系统实现的可行性进行了论述。本文档的读者是项目策划、设计和评审人员。（楷体，四号）

2.背景 3.定义 4.参考资料

二、可行性研究的前提

1.要求 2.目标

3.条件、假定和限制 4.进行可行性研究的方法 5.评价尺度

三、对现有系统的分析

1.处理流程和数据流程 2.工作负荷 3.费用开支 4.人员 5.设备 6.局限性

四、所建议的系统

1.对所建议系统的说明 2.处理流程和数据流程 3.改进之处 4.影响 5.局限性

6.技术条件方面的可行性

五、可选择其他系统方案

软件文档写作 篇3

1. 用户文档位置重定向

资源管理器“此电脑”右侧窗口中，列出了视频、图片、文档、下载、音乐、桌面等分类。逐一单击右键并选择“属性→位置”选项卡，点击“移动”按钮（图1）；接下来，在C盘之外的其他数据分区选择目标文件夹位置，点击“选择文件夹”，即可完成系统用户分类文件夹的转移。

改变用户文件夹位置，还可以通过系统设置窗口完成。在开始菜单中点击“设置”按钮，进入系统设置窗口后依次选择“系统→存储”选项；在接下来弹出的“保存位置”窗口中，通过选择C盘之外的分区，可重新设置新的图片、视频、音乐、文档的保存位置（图2）。

2. 应用安装位置自定义

应用的安装位置可改道为系统盘之外。在系统“设置”窗口的“保存位置→新的应用将保存到”选择列表中，将应用的保存位置选择为系统分区之外的分区（如F：盘）。这样系统盘的应用负担都传递给F：盘，从而解放了部分空间。

已安装的各类传统软件，若需要搬家到其他分区，可使用腾讯电脑管家工具，在工具箱中找到“软件搬家”工具，按操作向导选择软件搬移到新的位置即可。

3. 借助工具重定向软件安装

还可以借助于系统优化工具定制一键重定向软件安装目录。以使用360软件管家为例，在软件设置窗口的“安装升级”选项卡窗口下，首先选中“开启一键安装、一键升级功能”选项，然后在下方修改软件一键安装的目录为系统盘之外的分区目录（图4）。之后在软件管理器中安装软件，点击“一键安装”就可以安装软件到之前设置好的目录中。

小技巧

中文办公软件文档格式标准探究 篇4

关键词：文档格式,格式标准,UOF

UOF(Uniform Office-document Format),全称为“统一办公文档格式标准”,是基于XML置标语言、拥有自主知识产权的中文办公软件文档格式国家标准。

UOF以中文办公软件的普遍需求为出发点,合理解决了各国产中文办公软件间的差异性,形成了适合中文应用的、涵盖了从文档逻辑内容到显现格式、合理完整的技术体系架构,奠定了办公软件文档信息交换的基础。

1 中文办公软件文档格式与文档标准

1.1 格式与标准的制约模型

办公文档的格式标准是一个影响着办公文档编辑程序复杂度及显示质量的重要问题。办公软件的文档格式与格式标准之间存在着制约模型,如图1所示:

文档格式的标准严格控制着文档格式的定义,而格式的定义决定着格式的封装和解析,并同时受封装与解析的影响。 而作为文档格式标准,本身应该符合一定的准则,这样才能有更好的性能[1]。

1.2 UOF标准满足的若干准则

1.2.1 开放性

采用开放文档格式标准的意义在于确保用户的信息拥有权,实现信息的共享和互操作性。一个开放的文档格式标准,保证了用户文档中不会存在一些隐藏信息,可以保证任何用户今天保存的文档不会在未来因为技术因素而无法存取。这一点对于政府部门等机构来说具有非常重要的实际意义。

1.2.2 互操作性

在信息时代里,文档是信息的重要载体。但是这种重要性也是一种限制,资料始终是需要传阅的,该文档资料使用保存资料的该版本的办公套件才能阅读,而用其它版本的套件根本无法阅读。因此作为文档格式标准,必须解决文档的互操作问题。这不仅涉及到不同操作平台下文档格式的互操作,也涉及到统一操作系统平台上不同厂商的文档格式的互操作。而互操作性的实现,从很大程度上取决于开放性。

UOF就是因其开放性,各个办公软件厂商都能很清晰的了解到UOF格式的架构及源码,这很好的解决了互操作的问题,在促进文档的互通互换的同时,也实现了不同系统之间的集成,使得在多种环境之下的实现和部署更具有灵活性和可靠性,如此一来,用户存储数据的形式就有了更多的选择,而不是依存于某个单一厂商。

1.2.3 兼容性

事物都是不断发展的,文档格式也不例外,这就要求同种文档格式的不同版本要具有兼容性,对于这一点,更多地是需要解释程序的支持。当然格式标准需要对文档格式的兼容性做出定义,以延长文档格式的寿命。

另外,UOF与当前世界上主流的其它办公文档格式,OO XML(Microsoft Office Open XML Format)与ODF( OASIS Open Document Format)的兼容,对于UOF的今后的发展将起到关键作用。由于它们都基于XML置标语言,都基于三种应用——text、spreadsheet、 presentation;在主体层面上都有一些功能涉及,因此它们有相关的属性结构,句、文字段落等,很多方面可以做到一一对应。从这些可以看到,三者是可以融合的。

1.2.4 扩展性

可扩展性是考察文档格式是否良好的一个重要指标。文档格式如何在保持其基本特性不变的情况下增加对新的内容的支持,是可扩展性所要考虑的问题。可扩展性同时也影响了文档格式的兼容性方面的表现。

UOF是基于XML置标语言、采用了协会标准组织W3C定义的XML Schema作为模式定义语言、拥有自主知识产权的中文办公软件文档格式国家标准,在整个模式文档的描述上,UOF更多采用元素定义。多用元素而少用属性虽然增加了模式文档的大小,但是却增加了模式应用的灵活性和扩展性。

2 UOF文档格式框架及存储结构

2.1 文档结构

UOF文档格式中基本文档的正文部分的结构采用了XML的结构,具有结构化的优点。

UOF格式文档标准的根元素为UOF,在UOF格式标准里,根元素UOF顺序声明了元数据、书签集、链接集、式样集、对象集、用户数据集、文字处理(或电子表格或演示文稿)、扩展区、数字签名等子元素,涵盖了文字处理、电子表格和演示文档三种办公应用共同具有的基本要素,根元素UOF的层次结构如图2所示:

其中,元数据用来提供有关文档的基本属性说明,UOF文档格式中的元数据作为根元素UOF的子元素存储在基本文档中的文档属性信息段中,每条元数据以标记开始,并以标记结束,其中包含了标题、创建者、创建日期、编辑次数、编辑时间、字数、页数、段落数等文档的基本属性说明。UOF文档格式的元数据信息段是可扩展的。

而书签集、链接集、对象集、用户数据集、扩展区、数字签名这几个元素是可选的,它可以在包含元素UOF中出现,也可以不出现,书签集、链接集分别是书签和超级链接的集合,对书签集与链接集实行统一管理,可以方便用户进行检索和引用;式样集是式样的集合,包括字体、句、段落、文字表、单元格等对象的式样。在UOF格式标准中,式样集由复杂类型式样表类型定义;对象集是文档中使用的图形、OLE等各种对象的集合,对其进行统一管理,可方便文档中的对象引用,同时减少文档的存储空间;用户数据集是对用户数据的支持,用于电子公文等应用。

文字处理(或电子表格或演示文稿)分别是UOF标准中对文字处理应用(或电子表格应用或演示文稿应用)文档格式描述,在UOF格式规范中,这三种元素是作为选定组定义的,即允许且仅允许此选定组中包含的一个元素出现在UOF中。

图3显示了文字处理的层次结构,其格式主要由“字:文字处理文档类型”定义。

其中,“公共处理规则”包含了文档的全局设置、批注、修订信息、文档用户等内容;“主体”是文字处理文档主体部分格式的描述,其有四个子元素,即分节、逻辑章节、段落和文字标。

“分节”是两个章节的分割,一个文档至少有一个分节,且文档最前处必须有一个分节,它只含一个子元素,即“节属性”,描述紧随分节的章节的页面属性。

“段落”声明了六个子元素,“段落属性”、“句”、“域开始”、“域代码”和“删除”。其中“段落属性”描述段落的格式信息,它可以不出现,若出现,则必须作为段的第一个子元素;子元素“句”主要用来描述文本信息,包括“句属性”、“脚注”、“尾注”、“文本串”、“锚点”、“制表符”、“换行符”、“分栏符”、“空格符”、“分页符”、“引文符号”、“区域开始”和“区域结束”共十三个子元素。“句属性”描述句子的格式信息,同样,其若出现,则必须作为句子的第一个元素,“文本串”就是纯文本流,即句子的文本内容,一个句子可有多个文本流。元素“段落”不仅可以用于“主体”类型中,还可用于“逻辑章节类型”、“字:页眉页脚类型”等。

“逻辑章节”含四个子元素,“逻辑章节”、“分节”、“段落”、“文字表”,由此可以看出,章节支持逻辑章节结构。

2.2 UOF文档存储结构

UOF格式文件存储格式的基本结构如图4所示,包括XML文件、用户定义XML文件、二进制文件(文档外部引用的多媒体文件)以及文件定位信息(存储文件包中组成模块的位置信息)。

XML文件和用户定义XML文件都是XML文件。XML文件是一个纯文本结构树,由前述的文档格式规范定义,用以描述办公软件文档的基本信息。XML文件可以压缩,也可以不压缩,由用户自行决定。当压缩时,XML文件(包括内嵌的Base64编码数据)一并采用文本文件用的压缩方法。压缩后的文件,也由文件头和文件数据构成。用户定义XML文件是用户定义的逻辑格式文档,与XML文件通过标志符关联,提供了办公软件文档支持用户定义逻辑格式的途径。

文档中对于多媒体文件的处理采用两种方式。一种是内嵌的Base64编码多媒体数据;另一种是外挂多媒体数据文件。对于外挂多媒体数据文件方式在存储结构中就会出现二进制文件块。

为了表示存储结构中各个模块的位置,在存储结构中包括了文件定位信息。

图4中的二进制文件File1至Filen,是UOF的外挂多媒体数据文件,由文件头信息和文件数据信息组成。可以通过文件的文件头信息定位各个文件。XML文件的外挂文件通过内部文件名进行关联[2]。

3 UOF格式特点

3.1 内容与表现的融合

UOF建立在可扩展置标语言XML基础之上,采用协会标准组织W3C定义的XML Schema作为模式定义语言,置标语言产生的一个初衷是要做到文档内容和表现的分离。然而,UOF作为文档编辑工具使用的文档记录格式,一方面要尽可能地支持“所见即所得”的友好的编辑风格,这要求格式与内容混合编排;另一方面为了支持与其它应用的集成,还要做到格式与内容分离,这两者本身存在一定的矛盾。

现有技术中公开的文档记录格式一般是通过定义与显现格式相关的XML Schema来支持混合的文档格式与内容信息。目前,无论国际主流的、基于XML的办公文档格式(例如ODF,OOXML),还是中文办公软件文档格式UOF,所描述的内容主要是格式信息,文档的数据内容散布在格式信息之中,也就是说,为了支持办公软件“所见即所得”的第一类编排方式,办公文档格式采用内容与格式混排的方法[2]。

3.2 对用户逻辑数据的支持

为了支持与其它应用的集成,做到格式与内容分离也是必要的。办公文档格式中支持格式与内容分离的关键是要支持用户数据,即文档中真正的逻辑内容。为了解决这个问题,UOF中采用的方法是:将文档描述分为UOF格式树(格式描述)和UDS实例树(用户数据)两部分,通过关联机制建立起两者的联系,同时记录在文档之中。

为了支持用户数据,在UOF中建立了“用户数据集”,如图5:

“用户数据集”作为一个UOF格式树和UDS实例树关联节点的索引,记录每一对关联节点的对应关系。图中“用户数据”的子元素“用户XML”包含三个属性:“schema”即UDS;“文件名”(可选)指明存放用户数据的XML文件;“节点路径”通过XPath指向UDS实例树的节点。另一个“用户数据”子元素“UOF”则指向对应的UOF格式树节点。子元素“限制”用于指定具有这种对应关系的UOF文档节点是否可以修改、打印或浏览,以替代常规的“公文域”。子元素“名称”则用于命名映射关系[3]。

这个方法的优点是:文档的格式信息与用户数据互不影响,可以很方便地分别提取,并用UOF和UDS验证。因为有“用户数据集”显式指定对应关系,用户数据不再依赖于格式信息。另外,XML节点的对应十分灵活方便,可以把格式树的任何节点与任何用户数据对应。在实现中要注意的是,“用户数据集”的内容应在UOF格式树构造完成后生成。另外,办公软件的开发仍然需要考虑如何实现用户数据的导入导出,如何使用户可以随时建立用户数据节点和格式树节点的关联,如何在文档的编辑过程中维护这种关联等[3]。

4 结论

本文阐述了格式标准与格式的制约关系,UOF标准符合的若干准则,并分析了UOF格式的基本框架和特点。通过这些,我们可以看到,UOF文档格式是具有良好性能、符合中文办公软件要求的。在UOF规范推出后,中文办公软件的文档格式会迅速的从以前的多种集中到目前的一种,即UOF。UOF将为打破封闭办公软件文档格式的垄断,确保政府和用户对信息的拥有权创造有利的条件。

参考文献

[1]孔小玲.移动阅读电子文档格式与标准探究[EB/OL].

[2]ECMA-376,Office Open XML File Formats[S].

[3]李宁,牟永敏等.文档格式中“内容”与“表现”的分离与融合[J].电子学报,2007(02).

[4]李宁.中文办公软件标准化几个问题的探讨[J].信息技术与标准化,2003(12).

[5]胡萍,陈志鹏.XML文档与关系数据库数据转换中间件的研究[J].哈尔滨大学学报,2006(4).

软件设计文档 篇5

软件设计文档模板

文档编号 研发生产中心 项目名称 项目来源 QR-RD-022(Ver1.2)版本A1密级商密 AXx 系统Xxx 系统 详细设计说明书(内部资料 请勿外传) 编 检 审 批 写： 查： 核： 准： 日 期： 日 期： 日 期： 日 期：XX 公 司版权所有 不得复制文档变更记录序号 1 2 变更(+/-)说明 作者 版本号 日期 批准目录1. 引言....................................................................................................................................................... 4 1.1 编写目的和范围......................................................................................................................... 4 1.2 术语表......................................................................................................................................... 4 1.3 参考资料..................................................................................................................................... 4 1.4 使用的文字处理和绘图工具 ..................................................................................................... 4 2. 全局数据结构说明............................................................................................................................... 5 2.1 常量............................................................................................................................................. 5 2.2 变量............................................................................................................................................. 5 2.3 数据结构..................................................................................................................................... 5 3. 模块设计............................................................................................................................................... 5 3.1 用例图......................................................................................................................................... 5 3.2 功能设计说明............................................................................................................................. 5 3.2.1 模块 1............................................................................................................................... 5 3.2.2 模块 2............................................................................................................................... 6 4. 接口设计............................................................................................................................................... 7 4.1 内部接口..................................................................................................................................... 7 4.2 外部接口..................................................................................................................................... 7 4.2.1 接口说明.......................................................................................................................... 7 4.2.2 调用方式.......................................................................................................................... 8 5. 数据库设计........................................................................................................................................... 8 6. 系统安全保密设计............................................................................................................................... 8 6.1 说明............................................................................................................................................. 8 6.2 设计............................................................................................................................................. 8 6.2.1 数据传输部分 .................................................................................................................. 8 6.2.2 IP 过滤分部 ...................................................................................................................... 8 6.2.3 身份验证部分 .................................................................................................................. 8 7. 系统性能设计....................................................................................................................................... 9 8. 系统出错处理....................................................................................................................................... 91. 引言1.1 编写目的和范围说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑， 包括程序描述、 输入/输出、 算法和流程逻辑等， 为软件编程和系统维护提供基础。 本说明书的预期读者为系统设计人员、 软件开发人员、软件测试人员和项目评审人员。1.2 术语表定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号 1 2 术语或缩略语 PM 说明性定义 Project Manager,项目经理1.3 参考资料列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a.需求说明书、架构设计说明书等; b.本项目的其他已发表的文件; c.引用文件、资料、软件开发标准等。 资料名称 作者 文件编号、版本 资料存放地点1.4 使用的文字处理和绘图工具文字处理软件：[编写设计文档使用的文字处理软件，如 RedOffice ] 绘图工具：[使用的 UML 工具，如 Rose、Jude、Visio]2. 全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.1 常量包括数据文件名称及其所在目录，功能说明，具体常量说明等。2.2 变量本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.3 数据结构包括数据结构名称，功能说明，具体数据结构说明(定义、注释、取值)等。3. 模块设计3.1 用例图3.2 功能设计说明 3.2.1 模块 1模块 1 主要分为以下几个子模块：子模块 1、子模块 2 和子模块 N。3.2.1.1 子模块 1 3.2.1.1.1 设计图3.2.1.1.2 功能描述简要描述子模块 1 的业务功能。3.2.1.1.3 输入数据详细描述用户输入的数据(包括任何输入设备)以及这些数据的有效性检验规则。 详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。3.2.1.1.4 输出数据详细描述子功能 1 所产生的`数据以及这些数据的表现形式。3.2.1.1.5 业务算法和流程从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。3.2.1.1.6 数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明 (定义、注释设计、取值)等。相关数据库表，数据存储设计(具体说明需要以文件方式保 存的数据文件名、数据存储格式、数据项及属性等。 )3.2.1.1.7 源程序文件说明给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功能说明，包 含的前导文件及函数名称等。3.2.1.1.8 函数说明具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参数，全局 变量，局部变量，返回值，算法说明，使用约束等。3.2.1.1.9 限制条件 3.2.1.1.10 其他说明3.2.2 模块 2模块 1 主要分为以下几个子模块：子模块 1、子模块 2 和子模块 N。3.2.2.1 子模块 1 3.2.2.1.1 设计图3.2.2.1.2 功能描述简要描述子模块 1 的业务功能。3.2.2.1.3 输入数据详细描述用户输入的数据(包括任何输入设备)以及这些数据的有效性检验规则。 详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。3.2.2.1.4 输出数据详细描述子功能 1 所产生的数据以及这些数据的表现形式。3.2.2.1.5 业务算法和流程从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。3.2.2.1.6 数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明 (定义、注释设计、取值)等。相关数据库表，数据存储设计(具体说明需要以文件方式保 存的数据文件名、数据存储格式、数据项及属性等。 )3.2.2.1.7 源程序文件说明给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功能说明，包 含的前导文件及函数名称等。3.2.2.1.8 函数说明具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参数，全局 变量，局部变量，返回值，算法说明，使用约束等。3.2.2.1.9 限制条件 3.2.2.1.10 其他说明4. 接口设计4.1 内部接口 4.2 外部接口 4.2.1 接口说明例如：xx 子系统通过 xx 从 xx 子系统取得 xx 等，相关标准，调用示例，可根据需要增 加章节描述接口。4.2.2 调用方式例如：内部接口调用： 例: /** *通过用户服务号码取得该客户认证密码等信息，如果该客户存在返回为 0，其他情况 参考错误编码 */ public RUserInfo getUserInfo (String userNo);5. 数据库设计详见[xxx 数据库设计说明书] 如果数据库设计内容比较少，则直接在此处描述。6. 系统安全保密设计6.1 说明例如：由于存在与外部系统的接口,所以需要考虑访问安全的问题.6.2 设计例如：分为数据传输部分,IP 过滤部分,身份验证部分.[章节可补充]6.2.1 数据传输部分例如：在部分数据传递的时候,考虑以 https 协议,需要在部署的时候作相关处理.6.2.2 IP 过滤分部例如：可在系统前端通过 Filter 实现,该 Filter 实现对该地址访问的 IP 过滤作用.可 信任 IP 地址通过 xml 文件进行配置.6.2.3 身份验证部分例如：对信任的用户,颁发身份验证码,通过该标识进行身份识别.7. 系统性能设计8. 系统出错处理例如：为了在系统出现异常情况下给用户以明确的提示，可采用两种方式予以提示： 1.使用 Javascript 的 alert函数直接提示，这主要在输入或修改的情况下使用; 2.使用统一的错误界面提示，该界面对应于 errorpage.jsp 页面。错误界面样式如下 图所示：错误提示:“错误提示内容”返回错误提示界面