エンジニアにとって必要不可欠な言語・Markdown導入のメリット

こんにちは、DUです。

本記事ではエンジニアやソフトウェア開発に関わる全ての人間にとって欠かせないメモ記法、Markdownについて紹介します。

1. Markdownとは？

みなさんはMarkdownという記法をご存知でしょうか？

Markdownとは

2004年に開発された軽量マークアップ言語で、プレーンテキストとして記述した文書をHTMLに変換することができるもの（拡張子.mdのファイル）

です。HTMLよりもシンプルで記述量が少ないため、ソフトウェア開発の現場では重宝されている言語です。

また、本家Markdownをベースとして、さまざまな「方言：少し手を加えた言語」が存在し、我々エンジニアにとっても馴染み深い「Stack Overflow」や「GitHub」が表示用のフォーマットとして採用しています。さらに、「Qiita」でも投稿用のフォーマットとして全面的にMarkdownを採用しています。

つまり、ソフトウェア開発を行うITエンジニアには必須の言語の１つと言えるでしょう。

2. ３つの導入メリット

様々な、コミュニティでMarkdownが採用されていることは先ほどお伝えした通りですが、個人で導入したとしても十分メリットがあります。こちらでは３つの導入メリットをご紹介します。

可読性が桁違い

まずは、Markdownで記述したメモがどのように変化するのかご覧ください。

本ブログの下書きメモをMarkdownでささっと書いてみました。Markdownでかける記法のほんの少しの表現しか使用しておりませんが、圧倒的に右側のプレビュー画面の方が見やすくないでしょうか？

また、エンジニアであれば一度はアクセスするであろうGithubのページでも、有名なライブラリ・フレームワークであればreadme.mdが用意されているはずです。

これらも全てGithubによって見やすくレンダーされて、かなり見やすいページに仕上がっています。

共有スクリーンでも便利

私は自分主催の会議では、このMarkdownを使って議題をスクリーンに映しながら進行しています。進行の議題が一目瞭然であると同時に、メモを残すことで結論の共通認識がその場ですぐにできます。後に議事録として出席者に共有することも簡単ですので、非常にオススメです。

手軽な記法 => 多彩な表現

web系のエンジニアであれば、どの領域のエンジニアであれ最低限のHTML記法は理解しているでしょう。

その量に比べたらMarkdownは格段容易に覚えられます。

簡単な例を挙げると、

見出し）#, ##, ###, ####
リンク）[リンク表示テキスト](リンクURL)
コードインライン）`#{file_name}.html`
引用）> 引用内容
注釈）テキスト[^1]

詳細の記法に関しては「Markdown 記法」などのキーワードでググればすぐに一覧が取得できますので、そちらを参考にしてみてください。

---

本記事は記法に関するものではないため、下の記事のまとめ表を元に話を進めます。

Markdownにはこれだけの表現があります。簡単なコードや表などもMarkdownで表現することが可能です。しかも、どれもHTMLよりも全然シンプルであることがお分かり頂けたでしょう。

たったこれだけで、ただのメモが格段に見やすく表示できるのです。

環境を選ばずに修正可能

Markdownの良いところは、基本的なベースがプレーンテキストである点です。

ワード、エクセルファイルの場合、その拡張子に対応したソフトウェアが必要です。いちいち、それらのアプリを起動して開く手間がなく、普通のコードと同じようにドキュメントが扱えるのはエンジニアにとって非常に楽ではないでしょうか。

プレビュー対応可能なエディタについて

こちらに関しては別記事で詳しく紹介しようと考えておりますが、簡単に紹介しておきます。

基本的には、みなさんが使っているエディタのプラグインを探せばほとんどの確率でMarkdownのプラグインがオープンソースとして開発されているはずです。

私が確認しただけで、

1. VS Code
2. JetBrains製エディタ (WebStorm, RubyMine, etc.)
3. Atom
4. Sublime Text
5. Boostnote
6. Typora

などがあります。

Markdown用に別のエディタを用意するよりは、普段から使い慣れているエディタにMarkdownプラグインを追加して使用する方をオススメします。

気軽にメモを作成するという点や、プロジェクト内の.mdファイルを編集するという点で普段のエディタでMarkdownの扱いに慣れていた方が効率的です。

個人的にはプロジェクト内の.mdファイルはエディタで、それ以外はVimでMarkdownを扱っています。

バージョン管理が楽

最後のポイントはバージョン管理の観点です。

正直言ってしまうと、個人でMarkdownファイルを扱う分にはそこまで大きなメリットではないかもしれませんが、組織に属しているエンジニアであれば一番のメリットと言えるかもしれません。

ソフトウェア開発の現場では様々フォーマットの資料が乱立しているケースが存在します。

ドキュメントの種類は豊富で、ワード、エクセル、パワポ資料、PDFファイルなど枚挙にいとまがないですが、どれも共通して言えることは、誰がいつ・どこを編集したのかわからないということです。

クラウドなどのファイル共有システムを使用している現場では、ファイルごとのバージョン管理程度であればできているかもしれませんが、中々中身の一言一句をバージョン管理できていることは少ないのではないでしょうか。

その点、Markdownはプレーンテキストですので、他のプログラムファイルと同様にGitでバージョン管理が可能です。

これによって、いつどのタイミングで誰が変更を加えたのか、更新漏れしたのかGitのクライアントツール（Github, Bitbucket, etc.）で一目瞭然です。

当然、開発プロジェクトはエンジニアのみで行われるわけではないので、こういった状況は仕方がないのかもしれませんが、できるだけMarkdownでドキュメント化していくと、開発資産の管理が上手くいくと思います。

3. おわりに

以上で、Markdownの導入に関する情報は一通り紹介しました。

導入は非常に簡単ですので、まだ導入されていないエンジニアはすぐに導入してみてください。初めは面倒な点もあるかもしれませんが、すぐに慣れます。資料はあとで見返すためにある点を重視すると、メリットが大きいことに気づくと思います。