documentation - github 项目中有图表的文档吗？

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

3年前关闭。




Improve this question




我想为我正在处理的一个小 ruby​​ 项目编写一个架构文档，作为一个架构文档，它会受益于一些方框图和棒图。

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

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

Answer 1

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