現在自社サイトリニューアルのため、CodeIgniterでサイトを構築中です。
で、1人作業をしているわけですが、開発タスクのTracのチケットを仕様、設計メモにしてみました。
- チケット登録時に実装する機能の資料をチケットに記載
- 関連するDBのテーブル定義
- コーディングルール(意識して気をつけて書いてる点)
- Class,function,責務,URLの一覧
- 各責務の特徴、主な役割
- 実装作業したリビジョン番号をメモ的に記載
実際に作業をしてみると、作業最中は、作っている機能のチケットのページをずっと開きっぱなしで作業をしてます。
修正すべき項目は即時に修正。
ドキュメントとして保存しておくべき項目をすぐに追記。
そのチケットが終わる頃にはチケットが最終のドキュメントになることを狙っています。
実際作業をしてみると、チケットに書いてある内容を元に、PHPdoc形式で書くのに作業がスムーズでした。
目の前の作業中に目の前に資料がある状態のおかげで作業にも集中できました。
しばらく一人作業の場合はこの方法を練ってみて、
うまくいくようであれば事務所に導入してみようと思います。