Architecture 优秀软件文档和最佳实践的来源
我目前正在进行一个项目，以自动生成渐进式Web应用程序的文档（现在主要关注VueJs），并且我还希望包括一个仪表板，该仪表板提供有关该体系结构的见解。我的硕士论文基于此，所以我需要真正理解“好的软件文档”背后的核心原则是什么 有没有人知道什么是“好的软件文档”的定义，甚至有最佳案例的例子？我查阅了一些书籍和谷歌学者，但没有找到“核心原则”Architecture 优秀软件文档和最佳实践的来源,architecture,documentation,software-design,Architecture,Documentation,Software Design,我目前正在进行一个项目，以自动生成渐进式Web应用程序的文档（现在主要关注VueJs），并且我还希望包括一个仪表板，该仪表板提供有关该体系结构的见解。我的硕士论文基于此，所以我需要真正理解“好的软件文档”背后的核心原则是什么 有没有人知道什么是“好的软件文档”的定义，甚至有最佳案例的例子？我查阅了一些书籍和谷歌学者，但没有找到“核心原则” 我为所做的一切感到高兴，并提前向您表示感谢 软件文档化是一个非常宽泛的术语，实际上包括各种内容，如需求文档、软件体系结构文档、开发过程指南和源代码本身文档、测
我为所做的一切感到高兴，并提前向您表示感谢 软件文档化是一个非常宽泛的术语，实际上包括各种内容，如需求文档、软件体系结构文档、开发过程指南和源代码本身文档、测试文档，但也包括操作方面，如管理和用户手册 我建议先阅读和阅读 话虽如此，您特别要求自动生成文档。为此，您可以找到许多具有不同属性的工具（请参见和）。我真的不知道什么对什么目的最有用，所以您可能需要对您的应用程序进行一些评估 对于您问题中的最佳实践部分，一些人已经指定了文档的原则和质量标准（参见示例和）。不过，我觉得目前仍有很多工作要做，您可能会在不同的来源中找到不同的建议