マークダウン記法とは!はやく、見やすい資料作成のススメ

仕事術

突然ですが、先日お客さんに大絶賛で褒められた話をします。

お客さんに、手順の問い合わせがあり、回答をすることが今までにも何度もありました。

今までは、スピード優先でテキストベースでの回答をしてきました。つまり、文字のみでの手順の提示ですね。その際、やはりわかりにくかったのでしょうね、何度か追加で質問されました。

先日、恒例のように手順の提示を依頼されたんですね、そのとき、たまたま気分がよかったので、マークダウンという書き方で、手順を記載して提示しました。

すると絶賛されたというわけです。

お客さんからのレスポンスは以下です。

お客
お客

とても手順がわかりやすかったです! 迷うことなく進めることができました!!

そして、一度も追加の質問をされることがなかったのです。

マークダウンで記載するのは、テキストで書くのより時間がかかるため、避けてきましたが、追加の質問の回答に割いていた時間を考えると、あらかじめマークダウンで資料提供をするほうが、結果的に時間短縮になるということが今回わかりました。

お客さん視点でも悩む時間が短縮されるため、お互いにとって良いですね。

マークダウン記法とは

日本Markdownユーザー会によると、以下のように概要説明されています。

Markdown(マークダウン)は、文章の書き方です。デジタル文書を活用する方法として考案されました。特徴は、

  • 手軽に文章構造を明示できること
  • 簡単で、覚えやすいいこと
  • 読み書きに特別なアプリを必要としないこと
  • それでいて、対応アプリを使えば快適に読み書きできること

などです。

引用元: 日本語Markdownユーザー会

Markdownとは · 日本語Markdownユーザー会
Markdownの概要、記法、HTMLとの関係

 マークダウンのメリット

私の考えるマークダウンのメリットは、

  • 構造的に書くのが簡単
  • 表の追加も簡単
  • 簡単なのに見やすい
  • 画像を付けてPDF文書化できる

構造的に見せるのが簡単

そもそもみなさん、何か相手に文章で伝える際って、既に構造的に書いてませんか?

例えば、こういうことです。

(アンパンマンのwikipediaから引っ張ってきました。)

私の場合も、もともとテキストベースで提示していた手順も既にこういった構造はできていたのです。

マークダウン記法に合わせて構造を修正するだけでした。

マークダウンのメリット

私の考えるマークダウンのメリットは以下4点です。

  • 構造的に書くだけで見栄えが良くなる。
  • 表の追加も簡単
  • 画像をつけることができる
  • PDF文書化できる

構造的に書くだけで見栄えがよくなる

右が書き方、左が表示のされ方ですね。

`##`を見出しのレベルの数だけ頭につけるだけで構造的にできるんですね。

見栄えとしても非常にわかりやすいです。

表の追加も簡単

追加したいところで、 Ctrl + T を押してください。
すると、追加する表の大きさを指定するダイアログが表示されます。

OK を押すと、指定どおりの大きさの表が追加されていますね。

エクセルからの追加も簡単

なんと、エクセルの表をコピーして貼り付けるだけでも表を追加することができちゃいます!これは便利!

画像を付けることができる

画像を付けることが可能です。画像があるないでは、読みやすさが全く違いますよね。

特に良い画像持ってなかったので以前に食べたラーメンの画像ひっつけときました。

PDF文書化できる

PDFエクスポートできますね。その他にも、エクスポート形式はあります。

PDF化できました~!

こんな感じになりましたね。

マークダウンエディタおススメ

  • typora
  • vscode
  • その他

typora

私の一番のおススメはこちらです。

動作も非常に軽いため、PCにインストールしておくと良いと思います。

Typora — a markdown editor, markdown reader.

vscode

vscodeのプラグインでもマークダウンを扱うことができます。

テキストエディタをvscodeで踏襲している人は、こちらのほうが便利かもしれませんね。

その他

私は、上記二つしか、使ったことがないですが、マークダウンは今やそれなりに使われている記法であるため、エディタもそれなりに存在します。

最新のマークダウンエディタをまとめてくれている方がいましたので、そちらに丸投げします。

【2022年版】Markdown(マークダウン)エディタ厳選まとめ<Win/Mac/iOS/Android>
こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。 Markdown(マークダウン) とは、文章を記述するための軽量マークアップ言語です。プレーンテキストに対して「# 見出し」「*

マークダウンをPDF化する方法

マークダウンをPDF化する方法はさまざまありますが、typoraであれば、機能が完備されています。

その他、やり方は色々あるようですね。他の方法を知りたい方は、以下まとめてくれている方がいましたので、ご参照ください。

MarkdownをPDFに変換する方法 - Qiita
目的 Markdownで書かれた文章を印刷したいです。 Markdownそのままを印刷すると読みにくい htmlに変換して印刷しても読みにくい この問題を解決します。 手段 Chrome拡張 Markdown P...

わかりやすい資料作りを簡単にこなそう!

今回、誰にとってでもわかりやすい資料を心がけることで、お客さん、上司からの評価をあげることができました。

やったことは、普段はやっつけでテキストでまとめているのをマークダウンで画像付きに変更しただけです。

画像取得は手間のように思っていましたが。案外やってみるとスクリーンショットをとってぱっと張り付けるだけなので、思っているより時間はとられないことがわかりました。

画像の取り方などは、現在では様々なツールも出回っているため、工夫すればさらに時間短縮は出来るかと思います。

ぜひ、マークダウンを使いこなして作製資料のレベルをあげましょう!

コメント

タイトルとURLをコピーしました