资讯中心
News
上海网站开发公司网站制作时间不够怎样办?
发布时间:2022-09-27 00:00   您所在的位置: 网站首页 > 新闻资讯 > 经验杂谈

更好的上海网站开发公司Web开发人员总是可以写出带有好注释的漂亮代码,不过,他们一般也不可能编写专门给非开发人员阅读的文档。更好的工程师愿意猖狂地开发应用程序,不过不愿意花一点時间去编写文档或向其他人表明应用程序。他们认为,代码便是文档,而且有技术的人都可以理解代码,故此编写额外的文档是在浪费時间。

然而,现实情况是,并不是所有人都可以读懂API或配置管理清单。工作顾客、项目经理及其他非技术人员经常必须要清楚应用程序的内部工作方法,这样子他们才能更好地完成自个的工作,而技术文档并不能符合他们的需求。这些辅助人员是T组织正常运行的重要条件,假如没有这些信息,他们就会感到被疏远,不知道该如何与开发和运维团队交流,或者也不知道如何将他们的工作表达给工作部门、项目管理部门或其他非技术部门。


此外,还有一种借口:由于软件开发速度越来越快,故此开发人员和运维人员必须要进一步提高生产力,减少交叉培训、编写文档和内部培训的時间。这一样也是错误的。假如没有文档,咋们就无法将遗留系统引入组织中。遗留系统通常是每隔几年就必须要更新一次,由于知道如何维护这些系统的人可能已经离开公司,或者根本不记得如何维护这些系统,也没有参考资料可以查阅。

解决方法:将文档加到胜利条件中,共同分担文档编写责任

大多数基于Web的组织都会使用一种敏捷或精益方法来开发软件,而且这样的过程通常必须要定期極查已完成的上作和核对任务执行情况,从而落实项目的进展情况。这样子的话,文档就可以整合到开发与运维团队的文化中,而且组织也可以从中获益,例如产出品质更好的代码和发现设计问题等。

这样的过程必须要管理层的参与才能取得胜利。假如管理层只关注于完成进度,而不注意形成文档编写文化,那么这种过程是不可能胜利的。只是认同文档属于软件开发生命周期的一部分,但不使用必要的文档工具,也不投入時间,那么形成文档编写文化的目标就不可能实现。

而且,开发与运维团队都必须参与到文档编写文化的创建过程中,他们必须共同协作,而不能各自为政。在一部分超大型组织中,更好配备一位有开发或运维背景的全职技术文档工程师。由于这样的人有技术背景,从而也就不简单让人怀疑他的专业性。

好处:培养责任意识

配备一位有技术背景的文档编写人员(技术文档工程师)有利于鼓励开发与运维团队主动承担起编写代码文档、应用文档和流程文档的责任。一位经验多样的技术文档工程师可以指导他人编写出有效的文档,或者赞助他们养成编写文档的习惯。这样子可以赞助反对编写文档的工程师开始接受文档编写工作。

一旦每位上海网站开发公司网站制作工程师都愿意编写自个的文档,那么技术文档工程师就可以将角色从布道师和写手,转变为编辑和指导者,专职负责确保文档的正确组织和发布,以及赞助工程师改进技术文档的品质。当然,不同部门的技术文档工程师有不同的职责,这取决于Web工作的组织方法,不过作为文档编写的关键人物,他可以确保文档真正编写完成。


本文章由新概念互动原创,如没特殊注明,转载请注明来自:http://www.jianzhan0.com/jingyand/73059.html