MInor CoNtrol

プログラミング・ソフトウェアエンジニアリング・テック・ギークネタ

RDD(README駆動開発)をストレスフリーに加速させるauto-readmeを作りました

TL;DR

auto-readmeというものを作りました。
README.mdのテンプレート作成・編集をシームレスに行えるシェルスクリプトです。

RDDって?

RDD(Readme Driven Development)、通称README駆動開発とは、「先にREADME書いてからコーディングする」という、先に仕様書書くのは当たり前先進的な開発方針です。

RDDに欲しいもの

README駆動というからにはREADMEのフォーマットや書く内容をテンプレート化したいものです。おそらく殆どのRDD実践者の方は、自身にあったテンプレートをお持ちだと思います。僕もあります。 しかし、そのテンプレートを適当なディレクトリに置き、新しくREADMEを作成する際にコピペするのは面倒です。

そこでauto-readmeというシェルスクリプトを作成しました。詳しくはここREADME.mdを見てもらえれば良いのですが、簡単に言うと、readmeのコマンドだけで、

  • カレントディレクトリにREADMEが無ければテンプレートから作成する
  • あればそのまま(Vimで)編集する

中身自体は実質7行の小学生でも書けるスクリプトなのですが、コピペの手間を省けるのと、READMEの確認にlsしなくても良いので個人的には助かっています。

でも探せば上位互換のもっと便利なものがある気がする。ちなみに自分は下記の@b4b4r07さんのテンプレートを参考にしたものを使っています。感謝。
それでは。

参考