在github项目中有图表的文档？

Question

我想为我正在研究的一个小红宝石项目编写一个架构文档,并且作为一个架构文档,它将从一些盒子和棒图中受益.

在这种情况下,开源项目的成功是什么？我应该练习我的ASCII艺术,还是应该在我的doc文件夹中包含PDF或其他东西？

请注意,这是一个独立的文档,而不是从代码生成的API文档.

Answer 1

查看umlet-github ，它是一个 Google Chrome 扩展，允许您在UMLet中创建图表，将它们作为 UXF 文件存储在存储库中，并在 GitHub 界面中的浏览器中查看它们。