我在一家保险公司工作。我们有自己的开发部门，由近 150 人以及一些供应商（外包和定制应用程序）组成。在我们公司，我的团队制作了我们所说的非功能性逻辑库。也就是说，用于处理我们部门所有开发团队的横向事务的软件库，例如安全性、Web 服务、日志记录、消息传递等。大多数或这些工具要么是从头开始制作的，要么是根据实际标准改编的。例如，我们的记录器是一个基于 Log4J 的附加程序，它还将记录消息保存到数据库中。我们还定义了要在应用程序中使用的库，例如要使用的 Web 服务框架。我们在所有组织中都使用了很多 JavaEE 和 Oracle AS（带有一些 Websphere 应用程序服务器）。
这些项目中的大部分都记录了它们的体系结构（用例、UML 图等），并且通常可以使用生成的文档。现在我们看到的是，对于用户来说，有时很难使用我们提供的库，并且不断地提出问题，或者他们根本不使用它们。
所以我们计划为他们生成一个更友好的文档，所以我的问题是：软件文档应该有哪些最佳实践或清单？
我想到了一些东西：
- API 参考指南
- 快速入门教程
- API 生成的文档。
- 必须是可搜索的
- 网络访问
它还应该有什么？此外，根据您的经验，维护（保持最新）和发布此类文档的最佳方式是什么？