パソコンでのメモは全てMarkdownで取りなさい

齋藤孝風のタイトルですが、言いたいことは表題の通りです。

仕事中や家でPCに向かっているときなど、調べ物の過程&結果や自分で何か問題を解決したメモを残すことがあると思います。(メモしない?しましょう。)

あとは仕事だと会議の議事録をとったりもしますね。

で、そんな時にメモのフォーマットが毎回バラバラ・・・といった方や、オレオレフォーマットを使ってるけど他人とは共有していない、という方がほとんどではないでしょうか。

勿体無いので、そうしたメモなどの記録はとにかくMarkdown記法で書きましょう。

Markdownで書くべき理由

まず、そもそもMarkdownて何よ?という方はこちらを参考。

Markdownとは · 日本語Markdownユーザー会

blogやwikiなど様々な 基盤にそのままコピペできナレッジをためやすい

Markdownで書く一番の理由はコレです。

自分の経験や思ったことを蓄積するのに都合が良いからです。
はてなブログや、Wordpressもそうですし、ふつうのソフトウェアエンジニアが使うような今時のサービスでは、ほぼ100%がMarkdownで書けるようになっています。(むしろMarkdownで書けないOneNoteとかありえn・・・)

つまり、自分がMarkdownでメモや議事録を書いておけば、それらのサービスにコピペするだけで他人に共有できるレベルの見た目のものが出来上がります。

情報共有やナレッジ蓄積の一番の敵は「めんどくささ」なので、最初からMarkdownで書いておけば何もめんどくさいことがないです。

構造が整理されるので内容が散らかりにくい

絶対に散らからない、とは言いませんが、ある程度防ぐことができます。

Markdownで書いてリアルタイムプレビュー等で見てみると、見出しが整えられて表示されるので、階層を意識して書くことになります。そうすると、レベルの異なる要素が同列に並んでいたり、論理構造が破綻した文章になっているとすぐ気づきます。

Markdownで書いて公開しよう

フォーマットが統一されていると、書いたものが自分だけのものではなく、他人が参照できるものになります。
エンジニアは、自分が書いたものを人に読ませる機会が沢山あるので、そんなときに読みづらかったりとか、そもそも何も残っていないような状態だと、評価も落ちますしそもそも自分がレベルアップする機会をなくします。

とにかく、ナレッジやノウハウの類、自分が何に困ってどう解決したかといった情報は残す。しかも、他人にも読みやすいようにMarkdownで。ぜひやりましょう。

この記事を書いた人

yoshikiito

都内でテストエンジニア&ブロガーをやっている@yoshikiitoです。

ソフトウェアエンジニアの学習方法や成長するための考え方、会社に依存せず自分の力で生きていけるエンジニアになる方法などについて興味があります。
こういった方法や考え方、自分が試したことなどをブログを通じて発信します。

仕事は主にソフトウェアテストやテスト自動化。
趣味は浦和レッズと読書と技術書を買って積むこと。

技術評論社から本を出すのが夢

この記事が気に入ったら
いいね!しよう

最新の情報をお届けします