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

Question

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

对于这种情况，开源项目做了什么？我应该练习我的ASCII艺术，还是应该在我的doc文件夹中包含PDF或其他内容？

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

Answer 1

查看umlet-github，这是一个Google Chrome扩展程序，可让您在UMLet中创建图表，将其作为UXF文件存储在您的存储库中，并在GitHub界面中的浏览器中查看。

Answer 2

我想说使用Gliffy，您可以将图表导出到.JPG或.PDF并将它们附加到README.md文件中。

您还可以获得一个可共享的链接并将其包含在那里。非常便利。