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

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

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

    1、要控制文档书写格式;

    2、控制文档中章节、段落字体大小以及边距;

    3、尽量在文档排版上清晰明了;

    4、在内容上要简明扼要,客观陈述,不带有个人感情色彩;

    5、尽量在写文档的时候不要出现语气词,那样显得非常不严谨;

    6、写内容的时候先列好提纲,整理出大概思路等等。

  • 请您注意

    ·自觉遵守:爱国、守法、自律、真实、文明的原则

    ·尊重网上道德,遵守《全国人大常委会关于维护互联网安全的决定》及中华人民共和国其他各项有关法律法规

    ·严禁发表危害国家安全,破坏民族团结、国家宗教政策和社会稳定,含侮辱、诽谤、教唆、淫秽等内容的作品

    ·承担一切因您的行为而直接或间接导致的民事或刑事法律责任

    ·您在编程中国社区新闻评论发表的作品,本网站有权在网站内保留、转载、引用或者删除

    ·参与本评论即表明您已经阅读并接受上述条款

  • 感谢本文作者
  • 作者头像
  • 昵称:老妖
  • 加入时间:2013/6/13 0:00:00
  • TA的签名
  • 这家伙很懒,虾米都没写
  • +进入TA的空间
  • 感谢以下赞助商
分享按钮