软件文档之痛

关于软件文档的争论从来就没有停止过;最新的状态是:不断有新的争论加入。more

*软件文档有哪些?

本文的范畴包括:UX交互、需求规格说明、原型…

软件文档有用吗?

  • 从PM的角度,这是递交必须的形式

  • 从开发人员的角度,项目开始的时候,架构师或者开发人员总是需要需求说明、原型等资料,进行架构、编制代码

  • 从双方的角度,软件文档可以作为沟通工具。包括PM与开发人员的沟通、老员工与新员工的沟通,总是需要有些媒介、平台,这时软件文档可充当双方可共同理解的沟通桥梁

  • 从客户的角度,客户总是喜欢厚厚的文档,尽管他们可能根本就不看

软件文档为什么会有痛?

  • 过时、不一

这应该是文档最被人诟病的地方。过时、不一致的文档是无效的,因为也就没人看

现状是

  • 往往项目开始的时候,用文档进行沟通、设计;开发到后期,各种文档就被荒废了

  • 或者反过来,设计、开发的时候根本就没有文档,而是在快结束的时候,根据客户的要求、或者项目组发现需要一个架构图来进行知识传递,从已有代码反过来提取生成文档

未完待续…