背景
最近転職をして後輩(社会人一年目)を持つこととなり、様々教える機会が増えました。
その中で、「Markdownでドキュメント作成させたい！」と思ったので、その話をします。
なぜそれを思うのか
1. 「階層構造を作る」という行為の勉強になるから
Markdownでドキュメントを作ると、階層構造をある程度意識して作る習慣が根付きます。
階層構造とは物事を誰かに理解してもらうという目的のために、最も安易でかつシンプルな枠組みです。
しかし、それをあんまり理解していない人は実は社会に多く存在しています。
その人たちとの差別化という意味でも、階層構造を作る練習をMarkdownにおいて行うというのは悪くないアプローチじゃないかと思うわけです。
2. Officeドキュメント作成には時間がかかるから
PowerPointやExcel、Word等は作成に時間がかかります。体裁を整えたり、きれいな図や色使いなどこだわるポイントがたくさんあります。
しかし、その工数は本当に必要でしょうか。
MarkdownやMermaidではそのような工程をある程度自動化してくれます。
実際「他人に理解してもらう」という目的を達成するために、
体裁や色使いはそれほど重要ではないと個人的には思います。
個人的には、そんなことに時間を使っていないでもっと別の仕事に工数を使ってほしいと思うのです。
3. Gitで構成管理する時に便利だから
.docx, .xlsx, .pptxのようなバイナリ形式のファイルはGitなどの構成管理ツールに不向きです。
しかしMarkdownは構成管理もしやすく、Gitなどに躊躇なく格納することができます。
Markdownでドキュメントを作るにあたっての懸念点
1. 非エンジニアには共有できない
エンジニアならばMarkdownを知っている人がほとんどだと思うので大きな問題はないでしょうが、非エンジニアはそうはいきません。
Officeファイルでお腹いっぱいです…という非エンジニアはたくさんいますので、
その人たち向けの資料は当然Officeファイル等で提供するべきでしょう。
2. 表形式中心のドキュメントはMarkdownには荷が重い
どんなにMarkdownを使っていても、表形式の資料を作るならExcelがベストな選択肢でしょう。
別にOfficeファイルにもいいところはあると思っているので、使いどころは意識しておくべきだと思います。
最後に
もっと非エンジニアにもMarkdownの使いやすさを広めていきたいと個人的には思っています。
最近はMarkdownでPowerPointライクな資料が作れるMarpも使っていますので、いつか記事にしたいです。