zoukankan      html  css  js  c++  java
  • 论编写文档的重要性

      现代信息技术经过几十年的发展,人们的生活和工作几乎和电脑息息相关了。而对于经常使用电脑的人,会写文档就成为了工作必要的一部分。

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

      我们不止要会写文档,还要写出好的文档,我们写出的文档必须内容详细且明了,而且文档的排版必须按照规范,这样才能让别人能清楚的看出本文档的编写目的以及中心思想。

      在需求文档的编写过程中如果质量控制不到位,自然就会产生bug,然后设计人员就会依据不明确的需求文档设计出不准确的概要设计和物理模型,这样对一个项目来说是巨大的损失,所以编写一个高质量的文档能减少bug的来源。同时,当需求文档编写符合规范,概要设计上更加清晰流畅,代码编写才能控制的更加规范和标准,调高了代码的生产效率,提高了系统的质量。但是一旦文档编写得不好可能导致很多连锁反应,由此付出的代价是不可估量的,损失是惨重的,也是最不愿意面对的。

      文档是很多系统开发过程的基础,只有编写正确、完善的文档,才能顺利的进行系统开发。所以高质量的文档编写是百利而无一害的,编写文旦的重要性必须要得到重视。

  • 相关阅读:
    逆向初级-win32(四)
    逆向初级-C++(三)
    逆向初级-C语言(二)
    逆向初级-汇编(一)
    Kimabll数仓架构下如何确定模型落地哪些表
    浅谈数据仓库设计
    (转)Go语言的%d,%p,%v等占位符的使用
    (转)深入MySQL源码 学习方法 何登成专家
    (转)浅析MySQL二段锁
    (转)MySQL:为什么无法KILL在processlist中的语句
  • 原文地址:https://www.cnblogs.com/riven-meng/p/5424599.html
Copyright © 2011-2022 走看看