MarkDownを使って仕様書を作成

さて、今月のブログは…って、ブログの仕様、変わり過ぎじゃない!? 慣れるまで書きづらそうだなぁ(´・ω・`)

まあそれはさておき、今回はMarkDownについて書いてみたいと思う。

皆さん、仕様書を作成する際、Office系ソフトで作成することが多いと思います。

例えば、文書はWord、クラス図や シーケンス図 はVisio、またはExcelなどを使用することが多そうですが、

Word、Visioはなんだかんだ癖のあるソフトだし、Excelは結構無理やり作成している感が否めません。

そこでおすすめなのがMarkDownです。

MarkDownはいわゆる記法の一つで、決まった書き方をすることで文書や図などを作成することが出来るというものです。

実際の動作としては、テキスト文書をパーサ (parser)によってHTML化して表示するのですが、

つまり作成物はテキスト文書なので、軽いです。これも特徴の一つと言えるでしょう。

今回の現場ではVisualStudioCodeを使用している関係上、以下のサイトを参考にするのが手早かったので、リンクで紹介しておきます。

MarkdownとPlantUMLでソフトウェアの仕様書や設計書を書くための環境構築手順

https://www.eureka-moments-blog.com/entry/2018/12/17/121617

MarkDown記法なら、拡張子(.md)ファイルに文書、クラス図、シーケンス図などをまとめて記載出来る上、

記法自体もそこまで難しいものではありません。手早く各種資料を作成したい場合は有効な選択肢かと思います。

難点としては、あまり複雑なカスタマイズは出来ないことが多いので、凝った事をするのは向いてない、くらいでしょうか。

もし仕様書作成に使うソフトに迷ったなら、選択肢として一考してみるのも良いのではないかと。

以上