非エンジニアに送るMarkDown記法によるドキュメント作成

12
にほんブログ村 IT技術ブログへ

以前にMarkDown記法でシーケンス図等を作成するMarmaidというスクリプトを記事にしましたが、その際に使ったMarkDown記法って何?っていう方に送る記事です。

以下のYahooニュースでも触れられているようにエンジニアは知ってるけど、一般にはあまり知られていない便利な事って感じです。

MarkDownとは?

以下のようなサイトはゴロゴロ出てくるので詳しくはそちらを参照ください。

要するにHTMLを簡単に書くための書き方なんですが。本来は。
HTMLにすると当然ブラウザで表示できる。そして、印刷できる。最近はブラウザが印刷形式にPDFを選択できるので、あっという間にちょっとしたPDFドキュメントが作れてしまうのです。
WordやExcelでもPDFにエクスポートって機能があるので、それでも良いのですが、MarkDownを覚えておくと重たいOfficeツールを立ち上げずに、テキストエディタだけでドキュメントが書けます。
ただ、ファイルを変換する工程があるのでご注意を。

ファイル変換ツール

MarkDown形式のファイルは拡張子が(.md)のテキストファイルです。
変換ツールは、Visual Studio CodeやAtom等の対応エディタを使うか、ブラウザの拡張機能を使用するかどちらかだと思います。
まぁ、いつも使ってるブラウザに拡張機能を導入するのが楽ですよね。

Google Chrome向け拡張機能

Firefox向け拡張機能

私はChromeを普段使ってるので上記のMarkdown Preview Plusを導入しています。MarkDownファイルを作ったらChromeで新たなタブを開き、そこにドロップするだけでプレビュー表示されます。後は印刷メニューからPDFを選択して出力してあげれば良いです。HTMLのままが良ければ、そのままファイル保存してあげれば良いですね。
Firefoxの拡張機能は使った事ないですが、似たようなものかと。

覚えるべき書式

私も大して知らないので以下しか覚えてません。でもそれで十分だったり。
あとは必要に応じて前述のサイトで適宜調べます。

  • 見出し(h1)の書式は「#」+「半角空白」+「見出しの文字列」。先頭の「#」の数を増やすしていくとh2~h6と見出しレベルが下がっていく。
  • 段落(p)は空行を入れる。
  • 段落内の改行は行末に「半角空白×2」。
  • リストは「-」+「半角空白」+「文字列」。

活用方法

エンジニア的にはツールの設計資料的なもので使いますが。
社内で作るドキュメントとしては、一般的には議事録や社内通知文書とかありがちですね。

# 議事録

## 作成日
- 2018年6月15日

## 会議名
- 新商品〇〇販売計画

## 日時
- 2018年6月15日(月) 9時~11時

## 場所
- 当社会議室

## 出席者
- △社 A部長、B次長
- 当社 D部長、E、F、G(議事録作成者)

## 議題
- 新商品〇〇の販売展開プランについて

## 参考資料
- [資料1](aaaa.html)

## 決定事項
1. **販売開始1ヶ月間**は△社関連店舗の目立つブースに商品を展示してもらう。
1. 上記期間中、当社の製品購入者様には、**〇〇新商品のサンプル**を配布してもらう。

## 内容
- (Aさん) ~~~~ 
   - (Bさん) ~~~~
- (Cさん) ~~~~
   - (Aさん) ~~~~

## 保留・検討事項
- (今後の課題や新たな提案など)

## 次回会議予定
- (決まっていれば記載)

みたいな。
上記を.mdファイルで保存して、Chromeでプレビューしてみたのが以下です。

後は、ブラウザのメニューからHTMLとして保存するか、PDFで出力するかします。

会議中にWordでメモ取るのは辛いので、テキストエディタに殴り書きしておいて、後でそのファイルをMarkDown形式に成形して、PDF変換とかすれば、わりと手間を省けるかと。

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください

wpmaster
  • wpmaster
  • フリーランスシステムエンジニアの鎌形です。
    鎌形システムエンジニアリングとして都内で活動中です。

%d人のブロガーが「いいね」をつけました。