(2019-04-16更新)
目次:
本文の作成
Markdown
MarkdownはGitHubやはてなブログなど様々な場所で使える。 技術ドキュメンテーションのためのreStructuredTextとMarkdownを比較する | POSTD によるとMarkdownは図の表示方法など仕様が定まっていない部分でサイトごとに独自仕様になっていることがある。
reStructuredText
reStructuredTextはPythonのドキュメントを作成するために使われた。 図の表示などの拡張方法が仕様として決まっている。
- reStructuredText入門 — Sphinx 1.5.6 ドキュメント 主要な要素の記述方法が説明されている (Sphinxのドキュメント)
- ReStructuredText 入門 主要な要素の記述方法が説明されている
- はやわかり reStructuredText 上記より多くの要素の詳しい説明が載っている
図の作成
PlantUML
PlantUMLはJavaで動作するツールでUMLに関する多くの図を作成できる。 日本語のノードもそのまま記述できる。
- シンプルなテキストファイルで UML が書ける、オープンソースのツール
- PlantUMLを通じてロバストネス図の書き方を学ぶ - EurekaMoments
- PlantUML Example for モデルベース要件定義テクニック - Qiita
- Real World PlantUML 実際の図のサンプルとソースがたくさん載っている
- Sphinx に PlantUML のコードを埋め込む|へっぽこプログラマーの備忘録
blockdiag
日本人が作成したツール。 Pythonで動くためreStructuredTextとの親和性が高い。 Sphinx, Redmine, Trac, moinmoin, MediaWikiなどに組み込める。
次の4つのツールで成り立っている:
- blockdiag (ブロック図、画面遷移図、フローチャート)
- seqdiag (シーケンス図)
- actdiag (アクティビティ図)
- nwdiag (ネットワーク図)
www.slideshare.net
mermaid
mermaidはnode.jsで動くツール。 コマンドラインでも使えるが、WebページのDIVに入れるだけでブラウザで図がレンダリングされる。 次の図が作成できる。
