Documentation 软件环境文档检查表
我在一家保险公司工作。我们有自己的开发部门，由将近150人组成，还有一些供应商（外包和定制应用程序差不多）。在我们公司，我的团队制作了我们称之为非功能逻辑库的东西。也就是说，软件库处理与我们部门所有开发团队水平的事情，例如安全性、Web服务、日志记录、消息传递等。大多数或这些工具要么是从头开始制作的，要么是根据事实标准改编的。例如，我们的记录器是一个基于Log4J的appender，它还将日志消息保存到数据库中。我们还定义了应用程序中要使用的库，例如要使用的Web服务框架。我们在组织中使用的JavaEE和Oracle几乎与我们所有的组织一样（使用一些Websphere应用服务器） 这些项目中的大多数都有其体系结构文档（用例、UML图等），通常生成的文档是可用的。 现在我们所看到的是，对于用户来说，有时很难使用我们提供的库，用户经常问问题，或者根本不使用它们 因此，我们计划为他们生成更友好的文档，因此我的问题是： 软件文档应该有哪些最佳实践或检查表 我突然想到：Documentation 软件环境文档检查表,documentation,documentation-generation,document-library,Documentation,Documentation Generation,Document Library,我在一家保险公司工作。我们有自己的开发部门，由将近150人组成，还有一些供应商（外包和定制应用程序差不多）。在我们公司，我的团队制作了我们称之为非功能逻辑库的东西。也就是说，软件库处理与我们部门所有开发团队水平的事情，例如安全性、Web服务、日志记录、消息传递等。大多数或这些工具要么是从头开始制作的，要么是根据事实标准改编的。例如，我们的记录器是一个基于Log4J的appender，它还将日志消息保存到数据库中。我们还定义了应用程序中要使用的库，例如要使用的Web服务框架。我们在组织中使用的Ja
它还应该有什么？另外，根据您的经验，维护（使其保持最新）和发布此类文档的最佳方式是什么？将您的文档也保留在版本控制中 确保在每一页上都有一个版本号，这样你就知道你的用户是从哪里阅读的 启动CI服务器，并在更新后将文档推送到实时文档站点 像代码评审一样进行文档评审 狗粮：） 善良 丹