【问题标题】：Sources for good Software Documentation, Best Practices优秀软件文档、最佳实践的来源
【发布时间】：2019-12-03 18:33:30
【问题描述】：
我目前正在开展一个项目，以自动生成渐进式 Web 应用程序的文档（现在主要关注 VueJs），并且我还想包含一个仪表板，它可以提供有关架构的见解。我的硕士论文就是以此为基础的，所以我需要真正了解“优秀软件文档”背后的核心原则是什么。
有没有人知道什么是“优秀软件文档”的定义，甚至有最佳案例的例子？我查看了一些书籍和 Google Scholar，但没有找到“核心原则”。
我很高兴，提前谢谢你！
【问题讨论】：
标签：
architecture
documentation
software-design
【解决方案1】：
软件文档是一个非常广泛的术语，实际上包括各种内容，例如需求文档、软件架构、开发过程指南和源代码本身的文档、测试文档，还包括管理和用户手册等操作方面。
我建议先阅读this 和this。
话虽如此，您是专门要求自动生成文档的。为此，您会发现许多具有不同属性的工具（请参阅this list 和this discussion）。我无法真正说出什么对什么目的最有用，因此您可能需要对您的应用程序进行一些评估。
对于您问题的最佳实践部分，有些人一直在指定文档的原则和质量标准（例如参见 here 和 here）。不过，我觉得目前还有很多工作要做，您可能会在不同的来源中找到不同的建议。