Howto Explain everything

howto-explain.png

自分の作ったソフトウェアについて人に伝えるための手段まとめ

まずはソースコードから楽ちんクラス図生成

  • doxygen….ソースコードから自動的にドキュメントを生成してくれる。いわゆるリバースエンジニアリング。ただし、いくらコメントを沢山つけたとしてもこれだけだと不親切だよね。これを読むための指標となる、他のまとめた書類が必要なのだ。

まとめ書類を書く

  • Markdownが便利だ。簡単にHTMLとpdfが作れるからだ。

ブロック図を書く

階層図を書く

サポートサイト Wikidot.com