Tbpgr Blog

Recruiting Operations tbpgr(てぃーびー) のブログ

Markdown 駆動調査 = Markdown Driven Investigation #markdown

概要

Markdown 駆動調査 について

前提

私の記憶力が非常に弱いため、使わざるを得ない手法。
記憶力が良い人には不要かもしれない。

Markdown 駆動調査 とは?

何か調べごとをする際に、 Markdown 形式にまとめながら情報収集する方法。

・何かしらのエラー原因の調査
・技術比較
・新たに学ぶ言語、ライブラリ、手法の調査と習得

など、対象は何でも良い。

そのまま Qiita などに公開出来るレベルで整理しながらまとめる。
そして、常に HTML 変換後のプレビューを確認しながら書く。
私の場合は Sublime Text + Markdown Preview + github.css を利用している。

Markdown 駆動調査 の利点

・頭の中だけで記憶しながら調査するよりも、情報を整理できる

・必要であればそのまま技術エントリとして投稿し、他人との共有や自分の外部脳として利用できる。
はじめからこの方法をとっていれば、技術エントリ投稿へのオーバーヘッドが少ない。
また、本人は天才型で頭の中に情報を残せる場合も、他人との共有が必要になった際に
技術エントリ化しておくと話が早い。

・メモを残しながらの作業になるため、割り込みに強い

・調査量が多くなった場合に、全てを記憶しておかずに済む
=>二重調査が不要になる

・日常的に Markdown のドキュメントを作成するため、構成立てた文書の作成に慣れる

Markdown 駆動調査 の欠点

・短時間で調査が終わった場合には Markdown を記載するオーバーヘッドの方が大きくなる場合もある
・すべてを記憶できる天才の人には無駄な手順に見えるかも
(自分は記憶力薄弱なので、天才の気持ちは分かりませんけど)

メモ

・メモの作成は小さな粒度で。複数のフィーチャーにまたがると思ったらエントリを分ける。
最終的に、親エントリを作成して束ねれば良い

・タイトルの名前重要。言語なら言語名、手法なら手法名などを含める。
ある階層の記事が増えそうなら、タイトルの階層化も行う。
Ruby | 標準ライブラリ | XXXX #ruby」 など。
タイトルだけで記事内容を類推できるようにコンテキストを与える。
これにより、後日外部脳として利用する際に検索しやすくなる。

Twitter を意識するならタイトル末尾にハッシュタグを付与