skillup

技術ブログ

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

障害報告などでの伝える情報の視点

投稿日:

  • 障害の重要度(後続タスクにブロックがあるかいなか)、調査原因(仕様不理解、設計考慮もれ、ケアレスミス)、影響度(画面単位などで)
  • 障害が起こっているデータ(あるいはスクショなどで伝えられるか)
  • 再現プロセスについて(更新系のものが特に。同じものが容易に復元可能か、ローカルで見れれば一番よい)
  • 仕様書などがあれば参照できるドキュメント情報などと照らし合わせて設計が正しいかどうかの確認
  • 障害が起こっているログ情報(障害が起こっている前後、特にInパラメータやSQLデータなど)
  • 修正確認方法(ローカルでできるものか、外部APIなど検証以上の環境でないと確認が難しいか)

 

 

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

執筆者:


comment

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

関連記事

no image

コメントについて

リーダブルコード 第5・6章はコメントについて。 今回はコメントです。ここは結構賛否両論になるところではないかと思います。 ざっくり分けると「できるだけコメントは詳しく書くこと」という意見と「コメント …

no image

EntityとValue Objectについて

ドメイン駆動設計に関して勉強しています。参考にしている本がやたら難しいんで、トピックごとにネットで調べつつ進めていくのがよさげです。 今回はEntityとValueObjectについて Content …

no image

シェルの基礎+ユーザー切り替え関連

雑誌を見ていたらシェルの特集があったので、ちょっとメモリます。 補強したいところのみ要点をチェック。 Contents0.1 実行パスについて0.2 ビルドインコマンド0.3 シェル変数・環境変数0. …

no image

短いコードを書く

私が普段コードを書くときに考えていることは常にいかに短くかけるか、ということといかにバグを生み出さないかということです。 基本的にはできるだけ、短くシンプルに書くようにしています。 そうすることであと …

no image

ログの設計指針について

今まで10以上近い現場で仕事をしてきましたが、どの現場でも絶対必要になる(かつどこもあまり対策が取られていない)技術としては 検証したい状態の復元がすぐにできる(テストデータ作成) ログの適切な設計 …