githubプロジェクトの図を含むドキュメント？

Question

私が取り組んでいる小さなルビープロジェクトのアーキテクチャー文書を書いてみたいと思っています。アーキテクチャ文書では、いくつかのボックスとスティックダイアグラムの恩恵を受けるでしょう。

この状況では、オープンソースプロジェクトで何が行われましたか？私は自分のASCIIアートを練習するべきですか、あるいはPDFや何かを私のdocフォルダに入れるべきですか？

これはスタンドアロンのドキュメントであり、コードから生成されたAPIドキュメントではありません。

Answer 1

UMLetで図を作成し、リポジトリにUXFファイルとして保存し、GitHubインターフェイス内のブラウザで表示できるGoogle Chromeの拡張機能であるumlet-githubをご覧ください。

Answer 2

私はあなたが.JPGまたは.PDFへのダイアグラムをエクスポートしてREADME.mdファイルに添付することができ、使用Gliffyを、と言うでしょう。

また、共有可能なリンクを取得してそこに含めることもできます。とても便利な。