如何組織關於程序解決方案的信息？

Question

Неllо。我開發與證券交易所合作的系統（系統，見下文）。我的程序需要與系統進行交互的信息很多。這個系統有正式的聲明接口，但是除了這個聲明和對我的系統的要求之外，不同的細節經常改變。那麼，如何組織有關該系統的可用信息和我的程序的要求，以便它們易於理解並易於更改。

Answer 1

您的首要目標是爲程序公開的相關API創建文檔，然後爲配置文件添加文檔，甚至可以設置驗證程序進行配置。

從代碼註釋（取決於您的解決方案，它可能是.NET的XML文檔或PHPdoc等）自動生成的內容是第一步 - 這將幫助您在處理代碼時記錄類和接口。下一步是記錄非代碼資產。例如，如果您有XML配置，則可以編寫模式進行驗證。

之後是集成文檔 - 需要在生產服務器和/或工作站上執行安裝，升級和維護應用程序（包括支持腳本）的步驟。