将想法与焦点和您一起共享

网站制作时间不够怎么办?发布者:本站     时间:2019-03-25 20:03:27

最好的Web开发人员总是可以写出带有好注释的漂亮代码,但是,他们一般也不会编写专门给非开发人员阅读的文档。最好的工程师愿意疯狂地开发应用程序,但是不愿意花一点时间去编写文档或向其他人说明应用程序。他们认为,代码就是文档,而且有技术的人都能够理解代码,所以编写额外的文档是在浪费时间。
 
然而,现实情况是,并非所有人都能够读懂API或配置管理清单。业务用户、项目经理及其他非技术人员经常需要了解应用程序的内部工作方式,这样他们才能更好地完成自己的工作,而技术文档并不能满足他们的需求。这些辅助人员是T组织正常运行的重要条件,如果没有这些信息,他们就会感到被疏远,不知道该如何与开发和运维团队交流,或者也不知道如何将他们的工作传达给业务部门、项目管理部门或其他非技术部门。


 
此外,还有一种借口:由于软件开发速度越来越快,所以开发人员和运维人员需要进一步提高生产力,减少交叉培训、编写文档和内部培训的时间。这同样也是不对的。如果没有文档,我们就无法将遗留系统引入组织中。遗留系统通常是每隔几年就需要更新一次,因为知道如何维护这些系统的人可能已经离开公司,或者根本不记得如何维护这些系统,也没有参考资料可以查阅。
 
解决方法:将文档加到成功条件中,共同分担文档编写责任
 
大多数基于Web的组织都会使用一种敏捷或精益方法来开发软件,而且这个过程通常需要定期極查已完成的上作和核对任务执行情况,从而落实项目的进展情况。这样的话,文档就可以整合到开发与运维团队的文化中,而且组织也能够从中获益,例如产出质量更好的代码和发现设计问题等。
 
这个过程需要管理层的参与才能取得成功。如果管理层只关注于完成进度,而不注意形成文档编写文化,那么这种过程是不可能成功的。只是认同文档属于软件开发生命周期的一部分,但不使用必要的文档工具,也不投入时间,那么形成文档编写文化的目标就不可能实现。
 
而且,开发与运维团队都必须参与到文档编写文化的创建过程中,他们必须共同协作,而不能各自为政。在一些超大型组织中,最好配备一位有开发或运维背景的全职技术文档工程师。因为这个人有技术背景,从而也就不容易让人怀疑他的专业性。
 
好处:培养责任意识
 
配备一位有技术背景的文档编写人员(技术文档工程师)有利于鼓励开发与运维团队主动承担起编写代码文档、应用文档和流程文档的责任。一位经验丰富的技术文档工程师可以指导他人编写出有效的文档,或者帮助他们养成编写文档的习惯。这样可以帮助反对编写文档的工程师开始接受文档编写工作。
 
一旦每位网站制作工程师都愿意编写自己的文档,那么技术文档工程师就可以将角色从布道师和写手,转变为编辑和指导者,专职负责保证文档的正确组织和发布,以及帮助工程师改进技术文档的质量。当然,不同部门的技术文档工程师有不同的职责,这取决于Web业务的组织方式,但是作为文档编写的关键人物,他可以保证文档真正编写完成。

上海快3开奖记录 上海快3开奖结果 上海快3 大家乐彩票注册 上海快3走势图 上海快3 大家乐彩票注册 上海快3平台 上海快3平台 上海快3