1
我爲一家保險公司工作。我們有自己的開發部門，由近150人組成，還有一些供應商（外包和定製應用程序）。在我們公司，我的團隊製作了我們稱之爲非功能邏輯庫的東西。也就是說，軟件庫處理與我們部門中所有開發團隊水平相關的事情，例如安全性，Web服務，日誌記錄，消息傳遞等。大多數或這些工具都是從零開始制定的，或者是事實上的標準的改編。例如，我們的記錄器是基於Log4J的appender，它也將日誌消息保存到數據庫中。我們還定義了在應用程序中使用哪些庫，例如使用哪些Web服務框架。我們在所有組織（包括一些Websphere應用程序服務器）中都使用了JavaEE和Oracle AS。軟件環境文檔清單
這些項目中的大部分都有其架構記錄（用例，UML圖等），通常生成的文檔可用。 現在我們已經看到，對於用戶來說，有時很難使用我們提供的庫，並且不斷提問或者他們根本不使用它們。我們的問題是： 什麼是最佳實踐或軟件文檔應該有的清單？
東西在我腦海中：
- API參考指南
- 快速入門教程
- API生成的文檔。
- 必須是可搜索
- Web訪問
還有什麼應該能有多少？此外，根據您的經驗，維護（保持最新版本）的最佳方式是什麼，併發布此類文檔？