当前位置:首页 > 教程 > 生活 > 开发文档的重要性

开发文档的重要性

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

开发文档的种类

开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《 QA 文档》、《项目总结》等。 产品文档包括:《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》。用户文档《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。

为什么我要说这个话题呢?因为他让我感到失望和彷徨,顺便想吐槽不快,到底文档在我们项目中占据着多大重要性呢?有的小公司根本从项目的立项到研发再到项目结束,至始至终都没有一份完整像样的文档,这是让后来的人来接手维护项目最痛苦的事情。为什么会这样呢?我个人的看法是懒不想写,嫌麻烦,感觉是费力不讨好的事情或者根本不会写。我觉得最核心的问题就是懒不想写,根本就不想站在公司长远发展的角度去考虑问题,只顾眼前利益,或者说根本没有想做强做大的决心,只想墨守成规不想改变现状,我认为这样的公司只能小打小闹,永远成不了大气候。

我其实也是非常讨厌写文档,觉得麻烦,没有必要去写,现在我慢慢体会到写文档的重要性。当然不能为写文档而去写档,那么失去意义,那样我就认为完全没有必要去写。我不认为小公司就不用去写文档,而将关注点放在编码上,我认为这是不可取的,我认为文档和编码是同等重要的,甚至超过编码重要性。写文档的好处:1、降低项目依赖人的重要性,不会因为人员流动而导致项目无法正常运转,也可以让接手项目的人,快速上手;2、可以提高人的写作、语言组织能力;3、可追溯性,不至于有问题无从查起,做到有理有据;写文档的坏处就是耗时费力,需要花很大的精力去维护,当然从短期来看确实不是一件什么好的事情,但是从长远来看很有必要的,他将是整个软件研发过程的依据,有良好的追溯性,不至于过很长一段时间忘记这是做什么的。所以在我提出要写文档的时候为什么有人是抗拒的,我感到无法理解,于公于私都是对大家都有好处,可惜被抗拒,我很不理解这是为什么,想推动公司从管理、技术方面到更高一个层次,可惜我凭我个人之力很难做到。我现在是得过且过,还是继续坚持自已的原则,还是伺机而动呢?今天让我有这种冲动,因为感觉公司跟自已想法有些出入,没有什么成长性可言,只能混混时间,那违背了我的初衷。我只是希望能与公司同发展,共进步,不是止步不前,呆在原地不动,得过且过的想法。如果要是这样那我就不出来折腾。

那怎样才能写一篇清晰、严谨的文档呢?简述一下注意事项如下:

  • 要控制文档书写格式;
  • 控制文档中章节、段落字体大小以及边距;
  • 尽量在文档排版上清晰明了;
  • 在内容上要简明扼要,客观陈述,不带有个人感情色彩;
  • 尽量在写文档的时候不要出现语气词,那样显得非常不严谨;
  • 写内容的时候先列好提纲,整理出大概思路等等。

不管所开发软件的规模大小,在一个软件开发结束后,我们都会把开发过中的问题和项目开发总结一起记录下来,以防以后在开发过程中再有类似问题出现,提高我们的开发效率。

  • << iOS开发-应用跳转及通信
  • opencv之图片处理 >>
  • 作者:
    除非注明,本文原创:知道91,欢迎转载!转载请以链接形式注明本文地址,谢谢。
    原文链接:http://www.zhidao91.com/app-kaifa/

    相关文章 近期热评 最新文章

    • oracle数据库相关操作注意事项
      修改Oracle SGA(共享内存) 很多网站说修改Oracle的内存通过命令 如果你这么做了,那么恭喜你,你的Oracle数据库无法启动了。如果你已经这么做了,恢复Oracle启动的方...
    • 使用微信JDK实现微信接口签名验证
      要使用微信的接口必须在绑定的域名下测试;签名必须先向微信请求到access_token,然后用access_token再去请求jsapi_ticket,最后用jsapi_ticket和相关的参数按照ASCII码...
    • ABP开发指南系列教程(2) – 多层架构...
      为了减少复杂性和提高代码的可重用性,采用分层架构是一种被广泛接受的技术。为了实现分层的体系结构,ABP遵循DDD(领域驱动设计)的原则,将工程分为四个层: 展现层(...
    • ABP开发指南系列教程(1) – 入...
      ABP是“ASP.NET Boilerplate Project (ASP.NET样板项目)”的简称。 ASP.NET Boilerplate是一个用最佳实践和流行技术开发现代WEB应用程序的新起点,它旨在成为一个通用的WE...
    • Windows下 JIRA + Agile + Mysql 破解...
      本文讲述了Windows下 JIRA + Agile + Mysql 破解安装示例教程
    • c#类的构造函数继承关系示例剖析
      本文通过示例代码讲解了c#子类的构造函数与父类的关系,子类怎样集成父类的构造函数的。