我在一家保险公司工作。我们拥有自己的开发部门，由近150人和一些提供商（外包和定制应用程序）组成。在我们公司，我的团队制作了我们称之为非功能性逻辑库的东西。也就是说，软件库可以处理与我们部门中所有开发团队水平的事情，例如：安全性，Web服务，日志记录，消息传递等。大多数或这些工具要么是从头开始制作，要么是采用事实上的标准。例如，我们的记录器是基于Log4J的追加器，它还将记录消息保存到数据库中。我们还定义了在应用程序中使用的库，例如要使用的webservices框架。我们在所有组织中使用相当多的JavaEE和Oracle AS（使用一些Websphere Application服务器）。
这些项目中的大部分都记录了其架构（用例，UML图等），并且通常可以使用生成的文档。 现在我们看到的是，对于用户来说，有时很难使用我们提供的库，并且不断提问或者他们根本不使用它们。
因此我们计划为他们生成更友好的文档，所以我的问题是： 软件文档应该有哪些最佳实践或清单？
我想到了一些事情：
它应该还有什么？另外，根据您的经验，维护（保持最新）和发布此类文档的最佳方式是什么？
答案 0 :(得分：1)
将文档保留在版本控制中。
确保每个页面上都有版本号，以便您知道用户的阅读位置。
获取CI服务器并在更新后将文档推送到LIVE文档站点。
像您一样编写评论文档评论。
狗粮吧:)。
善，
丹