skillup

技術ブログ

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

小〜中規模程度のWEBアプリ作成で気をつけるべきこと

投稿日:

  • 初見の処理系(ライブラリ操作)などは休日などで最小パターンを確認しておくこと。実務で何時間も悩むと非常にストレスがたまる
  • テーブル設計命。あとで終えるようにトレースができるような値を入れておくこと。
  • 複雑な処理ほどテストやトレース(あとで動きをどうおったら楽か)を中心に考える。テストやトレースで考えるべき点として、
    1.コード自体を細かく分けて、検証しやすくする
    2.重要になる値、コード値やその情報のキーとなる値(例えば伝票番号など)は必ずテーブルにも入れ、ログにも吐く。
    3.デバッグオプション的なものを充実させる。
  • 例外系を中心に考える。まずはどんなエラーが起こるかを想定し、そこから正常系の動作を考える。
  • リリースまでにチェックリストを用意し、「考えなくても必要工程がすむようにする工夫」を行う。
  • テストが難しいもの(メール受信)ほどテストを最初に考える。どうテストをするかで組む。
  • 複雑な処理になってくると、コードをかくスキルだけでは対応できない。ドキュメントなどある程度プログラムを可視化する処理が必要になってくる。
  • ユーザーに頼んで本番環境の中にダミーユーザーとして入れてもらう事。検証が難しいパターンは大体においてデータの特殊性が絡んでいることが多い。
  • 「テストしておいて下さい」ではユーザーはテストをしない。イニシアティブをとって、テストが運ぶような(例えば一部の処理のみ実運用でやってもらう)手続きを取ること。
  • テストデータをうまく作るスキルを普段から身につけておくこと。fakerのようなライブラリでもいいし、うまく本番からデータを持ってこれるようにする。
  • エラー通知のライブラリ(Sentryなど)を入れる。
  • できればメンテ時間をあらかじめ組み込み、ユーザーがさわれない時間を作ってもらえると検証が簡単になる。
  • ログをおうプログラムがあってもいいぐらい、ログのトレースは重要。
  • サーバーが違うと正確なトレースができないので、ステージング環境をできれば用意しておく。
  • サーバー環境、バージョン情報の違いに注意。
  • 運用段階に入り、忘れかけた頃に障害が発生して仕様を忘れていることが多いので、すぐに検証できる方法を用意しておく(ドキュメント整理、本番と近い作業環境やDB、SQLログ、本番環境に常駐しているユーザー)

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

執筆者:


comment

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

関連記事

no image

フレームワーク作成時の注意ポイント

以前も多分書いていますが、フレームワーク作成時のポイントなどを列挙。 次元が違うものも多々含まれているかも。 ルーティング機能 基本設定情報の読み込み キャッシュ機能 データベース Form情報の管理 …

no image

プログラミングを習得するときに必要な2つの大事なこと

元々私は塾で仕事をしていましたが、いろいろ紆余曲折ありましていまではWEBエンジニアとして仕事をしております。 エンジニアとしてのキャリアは3年ぐらいなので正直あまりないのですが、開発者と平行してプロ …

no image

ダミーデータの作り方 まとめ

現在作っているアプリを顧客先で見せる機会があり、そのためダミーデータを入れる、という仕事がありました。 といっても画面からポチポチやったんでは時間もかかりますし、何より精神的にやられてしまいます。(汗 …

no image

メモリに関して 静的領域、スタック、ヒープなど

実務でメモリの調査をしましたが、肝心のメモリについてほとんどわかっていないのでメモ。 メモリの領域を大きく分けると静的、スタック、ヒープに別れる。 Contents1 静的2 スタック3 ヒープ4 そ …

no image

画面テストのツールに関して

Unitテストに関してはxUnit一択だと思いますが、UI系のテストツールについて。 IDE(コードを書かずにすむマクロ系)に関して全てChromeで動くことを確認しています。 Contents1 ツ …