优秀软件文档、最佳实践的来源

Question

我目前正在开发一个自动生成渐进式 Web 应用程序文档的项目（现在主要关注 VueJs），我还想包含一个仪表板，它可以提供有关架构的见解。我的硕士论文就是以此为基础的，所以我需要真正理解“优秀软件文档”背后的核心原则是什么。

是否有人有关于“优秀软件文档”定义的来源，甚至有最佳案例的示例？我查了一些书籍和谷歌学术，但没有找到“核心原则”。

我对一切感到高兴，并提前感谢您！

Answer 1

软件文档是一个非常广泛的术语，实际上包括各种内容，例如需求文档、软件架构、开发过程指南和源代码本身的文档、测试文档，还包括管理和用户手册等操作方面。

我建议先阅读 this 和 this。

话虽如此，您特别要求自动生成文档。为此，您会发现许多具有不同属性的工具（请参阅此列表和此讨论）。我无法真正说出什么对于什么目的最有用，因此您可能需要对您的应用程序进行一些评估。

对于您问题的最佳实践部分，有些人一直在指定文档的原则和质量标准（例如参见here和here）。但是，我觉得目前仍有很多工作正在进行，您可能会在不同的来源中找到不同的建议。

Answer 2

人工智能带来了一些令人难以置信的更新，特别是在流程文档领域。例如，Scribe 是一种通过遵循工作流程并截取屏幕截图/生成文本来记录您的流程的工具。

本文中还有其他很棒的工具：软件文档工具