如何在軟件產品中表示工作流程

Question

我有一項任務是調查我們公司軟件中的文件加載過程，我必須表示主要類和方法以及完成了哪些工作，最後編寫一個用某種圖表報告。

通過編寫文本文檔或使用UML來描述此工作流的最佳方式是什麼，如果UML應使用哪種圖表？

Answer 1

使用UML活動圖（http://www.agilemodeling.com/style/activityDiagram.htm）進行流程的高層次。然後，使用UML序列圖（http://www.agilemodeling.com/artifacts/sequenceDiagram.htm）獲得足夠複雜的部分以保證更多的細節。

Answer 2

任何文檔的最佳格式不僅取決於它攜帶的信息，還取決於目標受衆。如果你的觀衆由軟件工程師組成，那麼我認爲UML是一個不錯的選擇：它是標準化的，這意味着你不需要自己做記號或者解釋它，如果你保持圖表合理簡單，那麼可能性很高即使他們不是全職的UML專家，您的讀者也可以閱讀它們。

你不說的文檔是什麼，但至少我會建議在報告中的以下部分：

源視圖：類圖，可能與幾個包圖以及視實現語言和軟件包的數量和類型。 （如果程序包提供功能抽象，就像他們在Java中可以做的那樣，請考慮描述它們;否則它不是非常重要。）

運行時視圖：描述至少按鍵功能的控制流程的順序圖。

您也可以考慮加入一個或更多的這些：

外形設計的組件圖描述軟件的主要部分：例如一個DLL和API被用戶的代碼調用（我假設我們我正在談論某種圖書館例程）。這不應該涉及具體的方法調用或實現類，而應該在較高層次上描述軟件。

概念視圖：這應該描述關鍵概念，通常使用非常簡單的類圖。文件可能是這樣的，你應該考慮包括描述文件不同狀態的狀態圖（打開，關閉，eof ...）。與使用UML文檔（而不是例如生成代碼）一樣，在每個圖中都要注意慷慨，並且使用元素（類等）進行稀疏處理。對於旨在粘貼到文本文檔中的圖表，我儘量不要在每個圖表中放置超過六個元素。