システムの仕様書をMarkdownで書く

これまでも仕様書はテキストで箇条書きしていたんですが、ドキュメントのベースがExcelでした
Excelを方眼用紙にして箇条書きしてたんですよね
方眼用紙にしてたのは

• 画像を埋め込む時に位置が決めやすい
• 段落をつけやすい
• 色分けしやすい（背景とか一部に色付けしたりする）

これだけの理由でExcelを使っていたんですが、どうせ箇条書きにするならMarkdownで書けばいいじゃん。ということで今更ながらMarkdownで仕様書を書いています

(画像とか色付けとかは見やすくする為のものなので、Markdownの書き方でなんとかなります)

Wikiとかでも良かったんですが、気軽に使える良さそうなのが見つけられませんでした。。

ツール

Editor:　Visual Studio Code
Extensions:

• Auto-Open Markdown Preview
• Excel to Markdown table
• Markdown All in One
• Paste Image

なかでもPaste Imageが便利でいいですね

クリップボードにコピーした画像が簡単に保存できちゃうのが便利

「image/hoge」とか書いて、それを指定してペーストするとimageフォルダにhogeって名前で画像を保存してくれます

何も指定せずにペースとすると日時をファイル名にしてルートに画像が保存されます

便利！

テキストベースなのでGitで管理できるし、勿論差分もわかりやすいのでGood.

Markdownでの書き方（仕様書としての見やすさ）はまだまだ模索中なので、ベストな書き方が見つけられたら続報をブログに書きたいと思います

以上。