应用文档的最佳实践是什么?

what is the best practice for app documentation?

在软件开发领域工作了几年,我开始想知道如何在工作中有效地沟通 UX 的细节、功能更改、错误报告系统等等。

我在韩国的两家小公司工作过,发现沟通从头到尾都是口头交流,从来没有任何软件文档的习惯。

我认为这很奇怪,因为仅通过口头交流无法进行细致的规划和有效的软件管理。 (不过,我认为从某种意义上说,如果一家公司不够大,无法处理额外的工作量,这可能是合理的。)

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

我正在尝试自学如何在实际水平上自己可视化我的工作和练习文档。

所以,我的问题是

  1. 你知道有什么免费的图形工具可以帮助我绘制图表或 UML 等吗?
  2. 此外,如果您能谈谈如何记录您的应用程序以供将来重构和更好地管理,我们将不胜感激。

谢谢。

  1. Also, It will be appreciated if you could talk about how you document your app for future refactoring and better management.

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

注意下一点:

Working software over comprehensive documentation

在您的情况下,这可以解释为用 "clean" 编写的软件,并且采用易于理解的方式进行单元测试和验收测试比编写静态文档和 UML 图更有效。

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

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