我想为我正在处理的一个小 ruby 项目编写一个架构文档,作为一个架构文档,它将受益于一些方框图和棒图。
在这种情况下,开源项目做了什么?我应该练习我的 ASCII 艺术,还是应该在我的 doc 文件夹中包含 PDF 或其他内容?
请注意,这是一个独立的文档,而不是从代码生成的 API 文档。
我想为我正在处理的一个小 ruby 项目编写一个架构文档,作为一个架构文档,它将受益于一些方框图和棒图。
在这种情况下,开源项目做了什么?我应该练习我的 ASCII 艺术,还是应该在我的 doc 文件夹中包含 PDF 或其他内容?
请注意,这是一个独立的文档,而不是从代码生成的 API 文档。
查看umlet-github,这是一个 Google Chrome 扩展程序,它允许您在UMLet中创建图表,将它们作为 UXF 文件存储在您的存储库中,并在您的浏览器中的 GitHub 界面中查看它们。
我会说使用 Gliffy,您可以在其中将图表导出为 .JPG 或 .PDF 并将它们附加到您的 README.md 文件中。
您还可以获得一个可共享的链接并将其包含在其中。非常便利。