github項目中的圖表文檔？

Question

我想爲我正在開發的一個小紅寶石項目編寫一份體系結構文檔，並且作爲一個體繫結構文檔，它將受益於幾個盒子和棒圖。

在這種情況下，開源項目已經做了什麼？我應該練習我的ASCII藝術，還是應該在我的doc文件夾中包含PDF或其他內容？

請注意，這是一個獨立的文檔，而不是代碼生成的API文檔。

Answer 1

檢出umlet-github，Google Chrome擴展程序允許您在UMLet中創建圖表，將它們作爲UXF文件存儲在存儲庫中，並在GitHub界面中的瀏覽器中查看它們。

Answer 2

我會說使用Gliffy，在那裏你可以將這些圖導出爲.JPG或.PDF，並將其連接到您的README.md文件。

你也可以得到一個可共享的鏈接並將其包含在那裏。非常便利。