应用程序文档的最佳做法是什么?

时间:2016-07-17 03:22:01

标签: documentation refactoring data-modeling software-design

在软件开发方面工作了几年之后,我开始想知道如何在工作中进行有效的沟通,以及用户体验,功能变更,错误报告系统等的细节。

我曾在韩国的两家小公司工作,发现通信只是从头到尾口头完成,从未有过任何软件文档的习惯。

我认为这很奇怪,因为细致的计划和有效的软件管理不能仅通过口语交流来完成。 (虽然,我认为,从某种意义上说,如果一家公司的规模不足以应付额外的工作量,这可能是合理的。)

所以,最近,我真的对软件的书面沟通感兴趣,试图重新点燃我在大学学到的一点软件工程知识。

我正在努力教自己如何在实际水平上自己想象我的工作和练习文档。

所以,我的问题是

  1. 您是否知道任何可以帮助我绘制图表或UML等的免费图形工具?
  2. 此外,如果您能够谈论如何记录您的应用以进行未来的重构和更好的管理,我们将不胜感激。
  3. 谢谢。

1 个答案:

答案 0 :(得分:2)

  
      
  1. 此外,如果您能够谈论如何记录您的应用以进行未来的重构和更好的管理,我们将不胜感激。
  2.   

我认为您需要阅读有关敏捷软件开发的内容 Manifesto for Agile Software Development

注意下一点:

  

通过综合文档工作软件

在您的情况下,这可以解释为软件以“干净”和可理解的方式写入,单位和验收测试将比编写静态文档和UML图更有效。

我发现UML图很适合在开始时设计组件(但通常使用白板)。然后,在创建了所有需要的单元,验收测试后,所有图表都被丢弃了。

常规代码审查是分享最佳实践,代码样式或有关开发软件的其他信息的良好动态工具。因此,当您定期在成员之间分享有关软件的知识时,信息将在团队内部保持最新。