skillup

技術ブログ

ドキュメント作成 プログラミング全般

ファジープロジェクト対策 その1

投稿日:

5月ぐらいから着手していたプロジェクト(顧客管理ソフト)が終焉を迎え、検証段階に入ったので、記して置きたいことなど。

数ヶ月程度ですが、自分が携わったプロジェクトの中では過去最大クラスのものでした。

ポイントとしては、WEB系にはありがちだと思いますが、下記のように作りたいものがファジーだったりすることが多いです。

  • 仕様が不明な点が多い、固まっておらず、質問しても顧客のレスも遅い
  • 仕様書がない。あってもあまり機能していない、テーブル定義書やデザインデータがない
  • ドキュメント自体残す習慣があまりない

ようは仕様が曖昧なまま「こんなのが作りたい」と言われるケースです。自分の場合は某WEBサービスをベースに作って・・などと言われたので、まだよかった方だったのかもしれませんが・・・

便宜上ファジープロジェクトと定義します。

以下のような点がポイントでした。

常にメモを残す

ドキュメントとかがないので、数ヶ月単位のプロジェクトになると作った意図とかを忘れてしまいがちになるんですね。

最悪なのが間違って作り直してしまうことです。そのためにも自分への備忘録として、常にメモを残すこと。

単純ですが、これがあると上記のようなミスが防げ、地道に効率アップをすることができます。

テーブル設計

何と言ってもデータベースの設計がもっとも影響度が大きいです。しかもテーブル定義書がないので、手探りでこんな感じかな?で作るしかありません。

これなんですが、やはり一般的な業務管理プロジェクトのテーブルをたくさん見ておくことがポイントになります。

いわゆるアンチパターンやグレーパターンなど言語化できる部分もありますが、ステータスはどのように管理するか、正規化をどの程度行うかなどはどうしても経験に寄るところが多いです。

以下のような本で勉強すると言う方法もあります。
グラス片手にデータベース設計~販売管理システム編

実践的データモデリング入門 

コーディングスキル+ユニットテスト

次に大事だと思ったのは常識的なコーディングスキルとユニットテストです。

テストはTDDとかそういった原理主義的なものではなく、粒度を細かくすることで該当箇所の挙動をすぐに確認できることが目的です。コーディング時に気をつけるべき点としては以下のような点。

  • メソッドが適切な役割で設計されているか
  • メソッドの行数は30行程度か
  • メソッドの引数を変数でおくことと、ハッシュやオブジェクトなどでおくことのメリット、デメリットを理解しているか
  • クラスが役割に応じて分割されているか
  • クラスの行数は多くても300行程度か
  • テスト可能なコードか
  • (一つ上のものとだいたい同じですが)画面からデータを入れる場合であってもテスト(コマンドライン)により挙動が確認可能か

長くなるので後編へ。

-ドキュメント作成, プログラミング全般
-

執筆者:


  1. […] 前回に引き続き、大事だと思ったこと。一部単なるフレームワークの作り方的な内容になっているかも。 […]

comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

単体テスト仕様書について

おそらく開発者が書きたくないものの筆頭になるかと思う単体テスト仕様書ですが、うまく使うと有益なコミニケーションツールになります。 Contents1 ユーザーのフロー体験・説明書2 前提となるデータ3 …

no image

コード静的解析ツールを使った際の気づきなど

最近のプロジェクトでコード静的解析ツール(phpcs,phpmd)を使った際の気づきなど コードを書きながら常時エディタがチェックするタイプのものでないとまず無理(保存するたびでも無理だし、コミット時 …

no image

データのシリアライズ

おととしにJavaをやったときにでてきましたがSessionに情報を格納するときにでてきたシリアライズについて。 セッションはステートフルな状態を実現するための便利なデータの保存方法ですが、値をオブジ …

no image

webの仕組み その2 リクエストとレスポンス

クライアント(ブラウザ)はサーバーとの接続を確立した後、各種リクエストを送信します。サーバーはそれにこたえテキストや画像などのリソースをクライアントに転送します(これがレスポンスです。) Firefo …

no image

テストコードを読みやすくする

リーダブルコードも最終章に近づいてきましたね。 今回はテストコードについて。 以前のプロジェクトではテストコードを書いていたのですが、今携わっているプロジェクトでは書いてないです・・・ テストを書く目 …