実践的なREADME駆動について

README Driven Development

実践的なREADME駆動の話をしてるスライド。

以下のイベントでのスライドらしい

Write The Docs EU – A two day conference for technical writers, documentarians, and all those who write the docs.

ユーザーがそのツールを選ぶのにドキュメントは大事な指標であり、README駆動開発とは何かについて紹介してる。
README駆動のメリットしてはコードを書く前にバグを直す、コードのスケッチングできる点を上げてる
実際にREADMEをPRしてレビューやmdlintでチェックすることで、一つのREADMEというエントリーポイントが存在することになる。

Who, what, when, where, why and how.

そのREADMEを通してビジョンを共有し、明示的な意図(6W)を書くことで、チームの対話がより簡単になり、結果的にコードを書く時間や質が良くなるという話だった。
単純にREADMEをかけという話じゃなくて、それを行う事でどういう事が起きるのかについて踏み込んでいてよかった。
mdlintとか紹介してたけど、READMEとコードって少しまだ距離があるから、それを開発スタイルで補完できるのかもしれないと感じた。

ChrisWren/mdlint
vesln/jsmd

広告

コメントを残す

以下に詳細を記入するか、アイコンをクリックしてログインしてください。

WordPress.com ロゴ

WordPress.com アカウントを使ってコメントしています。 ログアウト / 変更 )

Twitter 画像

Twitter アカウントを使ってコメントしています。 ログアウト / 変更 )

Facebook の写真

Facebook アカウントを使ってコメントしています。 ログアウト / 変更 )

Google+ フォト

Google+ アカウントを使ってコメントしています。 ログアウト / 変更 )

%s と連携中