Markdownで書類を書こう

注意: この記事は1年以上前に掲載されたものです。情報が古い場合がありますのでお気を付け下さい。

最近、仕様書などの書類を書くときに、ExcelはおろかWordもあまり使わなくなり、Markdownで書くパターンが増えてきた。MarkdownはシンプルながらもExcelやWordにはない決定的なメリットがあり、使わない手はない。

まず、Markdownを使うメリットについてあげてみたい。

動作が軽い(テキストエディタで編集可能)
エディタによってはプレビューも可能
記述が簡潔
Gitを使えばバージョン管理が可能(運用方法にもよるが、差分レベルで誰がどこを編集したのかを確認できる)
Word/HTMLにコンバート可能

一方、デメリットは以下の通りである。

見た目を調整できない
書き方を覚える必要がある
表を多用するタイプの書類には向かない

これらのメリット・デメリットを踏まえると、仕様書にMarkdownを使うというのも十分検討すべきであろう。

では、実際にMarkdownで書類を書いてみよう。ここでは、ダミーテキストを使って以下のように書いてみたい。

# Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipisici elit, 
sed eiusmod tempor incidunt ut labore et dolore magna 
aliqua. Ut enim ad minim veniam, quis nostrud exercitation 
ullamco laboris nisi ut aliquid ex ea commodi consequat. 
Quis aute iure reprehenderit in voluptate velit esse cillum 
dolore eu fugiat nulla pariatur. Excepteur sint obcaecat 
cupiditat non proident, sunt in culpa qui officia deserunt 
mollit anim id est laborum.

-----

Duis autem vel eum iriure dolor in hendrerit in vulputate 
velit esse molestie consequat, vel illum dolore eu feugiat 
nulla facilisis at vero eros et accumsan et iusto odio 
dignissim qui blandit praesent luptatum zzril delenit 
augue duis dolore te feugait nulla facilisi. Lorem ipsum 
dolor sit amet, consectetuer adipiscing elit, sed diam 
nonummy nibh euismod tincidunt ut laoreet dolore magna 
aliquam erat volutpat.

上記の文章をエディタを使って記述、Markdownのプレビューを行えるエディターでプレビューすると、見た目にも反映されるようになる。これをうまく使っていくことで、高効率に文書を書けるようになるだろう。

なお、Markdown文書で実際に書ける記述については、Markdown文書の書き方 (その1)でも一部を記述しているので、是非とも参考になればと考えている。