マニュアルを作る際は何のツールが良いか検討した

マニュアル作ることってそんなにないから、どうやって作るか迷った。

 

議論し始めて良い悪いが発散しそうだったので、マトリクス図に落とし込んだ。

 

どっちがいいかっての決めるのにはやっぱりマトリクス図作るのがわかりやすいなって思っている今日この頃。

 

	メリット	デメリット
Markdown	コード管理が楽 デザインの統一ができる 分散開発しやすい CIに組み込める 制作ファイルサイズが小さい 文字で検索できるコンテンツになる 文字コンテンツなので、SEOに効果が強いかも	記法を知らなければ書けない 細かいデザインが難しい 矢印を載せたり、写真の加工と文章を書くソフトが別になる PDF化するのは専用のツールチェインが必要になりそう 文字の説明は読まない人多い
Adobe XD	一本のソフトで写真の加工もレイアウトもできる。ビジュアルで書ける ツールの力でPDFできる ツールの力でJPEG出力できる 画像は伝わりやすい	編集にソフトが必要 バージョン管理が難しい 分散開発しにくい 制作ファイルサイズがでかい CIに組み込めない 画像で出力するので検索しにくい 画像コンテンツなのでSEOに弱くなるかも

 

今回の決定

 

メリットの数ではMarkdownのほうが数は上回った。

 

だけど、数で選ぶものではない。

 

PDF出力の容易さ、矢印を入れたり画像加工も兼ね備えたツールであるので作るのが容易であることのメリットを強く感じたので、XDにしました。

 

 

 

余談、Dropbox Paperについて

 

こういう図を作る際でも、最近はDropbox Paper最高だと思うんだ。

 

フォントもいいし、マージンもいいし、文章を書いて気持ちいい。

 

表も作りやすい、そんでもってマークダウンに貼り付けられる。

 

ほんとUI/UXが素晴らしいアプリだと思う。