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

Stack Overflow用户

提问于 2019-12-02 23:57:40

回答 1查看 133关注 0票数 0

我目前正在致力于一个项目，以自动生成渐进式Webapp的文档(主要焦点现在在VueJs上)，我还想包括一个仪表板，给出关于架构的见解。我的硕士论文基于此，所以我需要真正理解“好的软件文档”背后的核心原则是什么。

有没有人知道什么是“好的软件文档”，或者甚至有最佳案例的例子？我在一些书籍和谷歌学者中查找，但没有找到“核心原则”。

我很高兴所做的一切，并提前感谢您！

发布于 2019-12-03 18:33:30

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

首先，我推荐阅读this和this。

话虽如此，您特别要求自动生成文档。为此，您可以找到许多具有不同属性的工具(请参阅this list和this discussion)。我真的不知道什么对什么目的最有用，所以你可能不得不为你的应用程序做一些评估。

对于您问题的最佳实践部分，有些人已经指定了文档的原则和质量标准(例如，请参阅here和here)。然而，我觉得目前仍有很多工作在进行中，你可能会在不同的来源找到不同的建议。

票数 0

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/59142520

复制

相似问题

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