摘要

文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,在软件的使用过程中有指导、帮助、解惑的作用。尤其在维护工作中,文档是不可或缺的资料。

1.jpg

背景

现代的软件开发已经走向社会化大生产,对于一个软件开发团队,人与人之间的沟通协作,以及对软件项目的管理变成了必然。由此,有了”软件工程“这个概念。就是用工程管理的思想来管理软件开发过程的方法论。而软件工程中,对于软件的定义便是”代码+文档“。只有代码或只有文档并不能称为完整的软件。并且,文档与代码是同等重要的。

软件工程中常用的开发过程有需求分析、概要设计、详细设计、编码及单元测试、接口测试、系统测试、运用维护等几个子过程。这些子过程都需要产生相应的文档。代码只产生于“编码”这一个阶段,这个阶段的耗时和成本有时甚至不到软件开发工作量的30%,而为了产生代码需要进行大量的准备工作和收尾工作都需要靠文档来完成。

9.jpg

一、什么是软件文档

软件文档是指一些记录的数据和数据媒体。在软件项目中,文档常常用来描述和规定软件的设计和实现的细节,说明使用软件的操作命令。

文档是软件的一部分,没有文档的软件就不称其为软件。软件文档的编制在软件开发工作中占有突出的地位和相当大的工作量。高质量和高效的开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软件产品的效益有着重要的意义。

2.jpg

二、文档的类型

从产生和使用的范围上看,文档可分为开发文档、用户文档、管理文档3类。

1.开发文档:开发文档与最终产品软件的技术密切相关,负责对软件开发过程本身进行描述和规范。定义了软件需要解决什么问题、怎样解决问题、如何进行测试等关键信息。

2.用户文档:负责对软件产品的使用、维护等信息进行描述,它是用户从不懂产品到流畅使用产品最有效的工具。

3.管理文档:负责对软件项目开发过程的管理以及信息的描述。管理文档与软件采用的实际技术无关,但在较大规模的项目组中起到成员间信息共享和协同作业等重要作用。管理文档的存在保证了软件项目管理中的关键因素的管理,能有效地被监控和实施。

3.jpg

三、文档的作用

1.提高软件开发过程的能见度,把开发工程中发生的事件以某种可阅读的形式记录在文档中。

2.管理人员可把记载下的材料作为检查软件开发进度和开发质量的依据,实现对软件开发的工程管理。

3.提高开发效率。软件文档的编制使开发人员对各个阶段的工作都进行周密思考、全盘权衡、减少返工。可在开发早期发现错误和不一致性,便于及时纠正。

4.作为开发人员在一定阶段的工作成果和结束标志。

5.记录开发过程中有关信息,便于协调以后的软件开发、使用和维护。

6.提供对软件的运行、维护和培训的有关信息,便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解,使软件开发更科学、更有成效。

7.便于潜在用户了解软件的功能、性能等各项指标,为他们选购符合自己需要的软件提供依据。

4.jpg

四、文档的管理和维护

文档是软件开发规范的体现和指南。质量差的文档会让使用者难于理解和削弱对软件的管理、提高软件成本。所以,在使用工程化的原理和方法来指导软件的开发和维护时,应当充分注意软件文档的编制和管理。

4.1针对性

文档编制应分清使用对象。按不同的类型、不同层次的使用对象,决定怎样适应他们的需求。管理文档主要面向管理人员,用户文档主要面向用户,这两类文档不应该像开发文档(面向开发人员)那样过多使用软件的专用术语。

4.2精确性

文档的行文应当十分确切。不能出现多义性的描述。同一栏目几个文档的内容应当是协调一致没有矛盾的。

4.3清晰性

文档编写应力求简明,如有需求,配以适当的图表以增强其清晰性。

4.4完整性

任何一个文档都应该是完整、独立的,它应该自成体系。例如,前言部分做一般性介绍,正文给出中心内容,必要时还有附录,列出参考资料等。

4.5灵活性

各个不同软件项目的规模和复杂程度有着实际差别,不能一律看待。应根据具体的软件开发项目,决定编制的文档种类。

image.png

结语

企业的发展,是个双人跑的比赛,需要和客户手拉手互相迈进。所以企业要做好的产品,更要做被人使用的产品。提高产品的使用深度,而帮助中心的设置能很大程度的在不被打扰的情况下深度学习了解产品。在为用户提供自主学习方式的同时,优化用户使用体验。

远齐已经将齐云平台部署、EIP框架、CMS框架、ADP开发工具等技术和使用操作文档封装在远齐云的帮助文档中了。未来,远齐科技将对更多的技术场景做内容整合,帮助用户更快的上手使用远齐产品,使开发人员之间更轻松的协作和交流,让文档更便捷、更智能。


上一篇:企业级单点登录——信息化体系建设的基础 下一篇:如何设计企业级的UI组件库?用远齐实战案例教会你!