プロジェクト内で README を有効に使う

プロジェクトが大きくなるにつれてドキュメントの重要性は増していきます。特にベンチャー企業では、スピード重視でドキュメントを残すよりも開発ばかりに重点が置かれてしまうこともあるかと思います。企画が決まり、じゃ開発、リリースこの日にしようみたいな具合に。とりあえずリリース後に整備しようと思っていても、もはやそんなモチベーションもなく、むしろ次のリリースに向けプロジェクトは進んでいきます。まさに今の自分のプロジェクトがこの状況で、見直さないとなと思っているところです。

ドキュメントなしでの開発

当たり前ですが、開発前の準備がないため開発中に諸々問題が発生します。仕様があいまいなのでここ変更したら別箇所に問題が起こる、開発進んだ段階で新らしく API が必要なことに気づく、など挙げればたくさんあります。開発の手戻りはとにかくコストが高いため、開発前にドキュメントまとめればこういった問題は防げるはずです。と言っても、ドキュメントを書くということもコストかかります。そこで README を有効に使い、そこに概要、デザイン、簡単な仕様、アプリであれば必要な API などまとめておけば、そこまでコストもかからず、その後の開発がかなり効率よく進むのでは思っています。

README の使い方を見直す

去年少し話題にもなった Readme Driven Development。先に README を書いてから開発に入るという手法。そして、その README をドキュメントとしても利用します。そこで機能開発する際は以下のようなテンプレートに沿って README を書こうと考えています。

Name
====

# Overview

## Design

## Description

## API

## Test

## Deploy

これによって、スピード落とさずドキュメントも残せて開発前にある程度の問題は潰せておけるのではと思っています。また人の入れ替わりがあっても引き継ぎがスムーズに進み柔軟な体制が組めます。リリースが完了したら Qiita Team にあげておけば一元管理できるので楽です。

まとめ

Readme Driven Development ベースにまずはこの手法取り入れてみて、プロジェクトにマッチした形にカスタマイズしていきたいなと。README しっかり書くだけでも色々な問題が解決する気がします。