文档章节

软件开发人员撰写文档的重要性

_编程菜鸟_
 _编程菜鸟_
发布于 2014/08/22 08:51
字数 292
阅读 93
收藏 2

    作为程序员,以前一直觉得只要把程序逻辑想的全面,注释写好就行了。但最近越来越觉得编写软件设计说明和软件使用说明书等软件设计类文档的重要性了。

    就拿软件使用说明书来说吧,以前程序编写完成后就直接给测试了,自己没写相关说明,测试人员也没写。时间长了连自己都忘记程序实现的功能有哪些,后台数据该如何配置。所以,在软件设计的不同阶段,各类文档一定要编写详细,并存档。

    软件设计过程,主要包括以下文档:

上图摘自: http://www.csdn.net/article/2014-08-12/2821148

     上述各类文档都应认真编写,最好能有各部门领导审核,然后存档。这样不仅能保证软件的完整性,而且方便用户使用和软件设计人员后期维护。

© 著作权归作者所有

_编程菜鸟_
粉丝 3
博文 115
码字总数 16846
作品 0
武汉
私信 提问
Java 全文搜索框架--Lucene

Lucene 是apache软件基金会一个开放源代码的全文检索引擎工具包,是一个全文检索引擎的架构,提供了完整的查询引擎和索引引擎,部分文本分析引擎。Lucene的目的是为软件开发人员提供一个简单...

匿名
2008/09/07
195.5K
331
Apache Lucene 6.2.0 发布,Java 搜索引擎

Apache Lucene 6.2.0 发布了。Lucene 是apache软件基金会一个开放源代码的全文检索引擎工具包,是一个全文检索引擎的架构,提供了完整的查询引擎和索引引擎,部分文本分析引擎。 Lucene的目的...

淡漠悠然
2016/08/25
2.4K
2
Apache Lucene 5.3.2 发布

Apache Lucene 5.3.2 发布,此版本的更新内容如下: Bug 修复: SOLR-7865: BlendedInfixSuggester was returning too many results (Arcadius Ahouansou via Mike McCandless) 详情请看:发行......

oschina
2016/01/25
1K
0
Apache Lucene 4.9.1 发布,全文搜索引擎

Apache Lucene 4.9.1 发布,此版本现已提供下载,包括 7 个 bug 修复,更新详情请看 CHANGES.txt 文件。 Lucene 是apache软件基金会一个开放源代码的全文检索引擎工具包,是一个全文检索引擎...

oschina
2014/09/25
1K
10
Apache Lucene 4.8.1 发布

Apache Lucene 4.8.1 发布,此版本现已提供下载,包括了 15 个 bug 修复,更多内容请看 CHANGES.txt 文件。 Lucene 是apache软件基金会一个开放源代码的全文检索引擎工具包,是一个全文检索引...

oschina
2014/05/21
1K
5

没有更多内容

加载失败,请刷新页面

加载更多

启动参数

常用启动参数,通过 -Dxx.yy=zz注入应用参数 -Deureka.instance.metadata-map.starkGroup=test3 -Dserver.port=8989 本地调试过程中,可改变端口来启动多个相同服务。修改启动的VM参数即可...

ZH-JSON
13分钟前
4
0
ES配置修改

查看配置 GET /_cluster/settings 修改配置 PUT /_cluster/settings{ "persistent" : { "xpack" : { "monitoring" : { "collection" : { "enabled" : ......

messud4312
25分钟前
3
0
Spring事务传播属性有那么难吗?看这一篇就够了

Spring事务传播属性有那么难吗?看这一篇就够了 笔者文笔功力尚浅,如有不妥,请慷慨指出,必定感激不尽 学习东西要知行合一,如果只是知道理论而没实践过,那么掌握的也不会特别扎实,估计过...

不学无数的程序员
25分钟前
4
0
VMware vSphere ESXi主机的访问控制

在vShpere中,访问ESXi主机的途径很多,如下: ESXi DCUI ESXi Shell ESXi SSH ESXi Host Client vCenter --> vSphere web client / vSphere Client VMware vSphere ESXi主机的访问控制,除了......

大别阿郎
50分钟前
5
0
大神讲解CGI、FastCGI和PHP-FPM关系图解

参考资料 概念了解:CGI,FastCGI,PHP-CGI与PHP-FPM:http://www.nowamagic.net/librarys/veda/detail/1319 php中fastcgi和php-fpm是什么东西:https://www.zybuluo.com/phper/note/50231 ......

网络小虾米
59分钟前
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部