ソフトウェア開発のベストプラクティス

どのようなものか

ソフトウェア開発のベストプラクティスとは、特定の条件で効果が確かめら
れ、通常の選択肢として使える方法です。たとえば復旧時間を知る必要があ
るなら、別の環境でバックアップを復元する方法があります。バックアップ
の処理が完了した記録からは、コピーが実行されたことが分かります。復元
まで試すと、データを実際に開けるか、どれだけ時間がかかるか、担当者の
その場の工夫に頼る箇所があるかが分かります。

研究組織やプロジェクト、標準化団体が方法を推奨することがあります。推
奨には、チームが独立して変更を展開できる、または変更を確認できる人が
いる、といった前提が伴います。チームは参考として採用する場合も、共通
の規則にする場合もあります。契約などで別途義務が定められていることも
あります。誰が何のために決めた規則かが分かれば、適用範囲や例外を認め
られる人を確認できます。

NISTのセキュアソフトウェア開発フレームワークのバージョン1.1は、さま
ざまな開発工程に組み込める高水準の実践項目をまとめ、各項目に作業や実
施例を示しています。この構成は、たどり着きたい結果と、そこに至る一つ
の方法を分ける参考になります。「変更をレビューした証拠を残せる」は結
果で、あるサービスの特定の設定を有効にするのは実施方法の一つです。別
のチームは、手元の工程で同じ証拠が得られ、必要な保護が保たれるかを確
認できます。

正式な名称としての使い方もあります。IETFはRFC 2026の第5節に記載され
た手続きでBest Current
Practiceの文書を発行します。RFC
8174は、関連する規約が定義する用語を大文字で使った場合に、どのような
条件で特別な意味を持つかを明らかにしています。一方、社内文書でベスト
プラクティスと呼ぶものは、一般的な推奨事項である場合があります。推奨
の出典と適用範囲を確かめてから、どこまで拘束力があるかを判断します。

なぜ重要なのか

方法が明確になると、変更のたびに同じ判断を繰り返す時間が減ります。新
しく加わった人は、レビューを頼む前に何を用意するかが分かります。運用
担当者は複数回の展開について比較できる情報を受け取れます。サービスを
共有する複数のチームは、どんな変更が互いへの連絡を必要とするかを決め
られます。「よく確認する」では判断が人によって変わります。「同じ注文
で二回請求されないことを示す」なら、実際に検証できる結果について話せ
ます。

通常の方法を決めておくと、例外も見つけやすくなります。小さな変更を頻
繁に出せるサービスもあります。機器のファームウェアを更新する場合、現
地で担当者が機器を隔離し、更新し、動作を確かめる必要があるかもしれま
せん。変更を小さくすることは、設計、試験、機器を更新する順序に役立ち
ます。実際に機器を触る頻度は、復元にかかる時間や現地の体制を考えて決
めます。

DORAは、共通のメインブランチで開発する方法を、小さな変更を頻繁に統合
するものとして説明しています。長く残るブランチをまとめるのに時間がか
かるチームにとって、検討する価値のある方法です。導入するチームには、
手元の結果を確認する仕事が残ります。変更を統合するまで何日かかるか、
何が差し戻されるか、展開後に何が起こったかを見ます。ブランチが少なく
なっても、一つにためる作業が増えたのであれば、統合が楽になったかは分
かりません。

実際の活用例

社内の集計ツールを担当するチームを考えます。変更は別の担当者が確認
し、共通のテストを通るのが通常です。ある月、抽出条件の誤りで月次報告
が遅れました。全テストに数時間かかるのは、一部が別の出力形式の確認も
行うからです。今回変更するのは抽出条件だけで、報告書を配る前なら元に
戻せます。チームは、どの検証があれば今回の変更に限って十分かを考えま
す。

まず、報告書の配布前に承認が義務付けられていないかを調べます。必要な
承認は、急ぎの場合も得ます。次に、具体的なリスクを示します。正しい行
を含め、従来の集計単位を保ち、他部門のデータが含まれないようにする必
要があります。開発者が結果の分かっているデータを使って試験し、実際の
行を期待値と比べます。別の担当者が変更と比較結果を確認します。前回の
報告書を手元に残し、配布を中止できる人も決めます。全テストは後で実行
し、より速い標準の手順が必要かを検討する材料にします。

例外の記録には普段の規則、例外を認める理由、維持する保護策、例外の期
限を書きます。実際にかかった時間と、結果も残します。同じことが翌月も
起きるなら、この報告書専用の高速な検証を普段の手順に組み込めます。組
み込む前に、わざと月を誤らせた入力や、除外すべき部門の行を与えます。
両方の誤りを検出できれば、単に所要時間を測るだけでは得られない根拠に
なります。

二十二本のリンターを使ったコミット時の検査の事例は、プロジェクトで合
意した確認項目を実際に守る仕組みを示しています。自動検査から漏れたア
クセシビリティーの問題の事例は、毎回同じ検査を実行できても、利用者が
体験する問題すべてをその検査で確認できるわけではないことを示していま
す。

問題が起きるところ

チェック欄を埋めることが目標になる。
用紙が埋まっていても、防ぎたかった不具合は起こり得ます。方法の違いが
結果に表れる例を選び、実物を確認します。復元されたデータを開けるか、
意図した利用者に新しい版が届いたかを確かめます。

道具を導入して作業が変わったと思う。
レビューのサービスを契約しても、変更に異議を唱える時間や背景知識まで
は得られません。何を実現するための道具かを書き、実際の変更で、必要な
情報が間に合うかを確かめます。

例外がいつの間にか既定の方法になる。
急ぎの仕事に使えた方法は繰り返し使われがちです。範囲、責任を持つ人、
残るリスクを減らす措置、見直す時期を決めます。同じ例外が続くなら、本
来の方法を公開の場で見直すきっかけになります。

前提を確かめずに手法をまねる。
頻繁に公開できるネット上のサービスと、現地作業が必要な設備では条件が
違います。元の手法が解決する問題と手元の問題を比べ、小さく試します。
何が改善で、どの結果が中止の目安になるかをあらかじめ決めておけば、観
察に基づいて採否を判断できます。

参考資料

  * NISTのセキュアソフトウェア開発フレームワーク、バージョン1.1 — 実
践項目、作業、実施例をまとめています。

  * RFC 2026の第5節 — IETFがBest Current Practiceを扱う手続きを記述
しています。

  * RFC 8174 — 仕様文書で大文字の用語が規範的な意味を持つ条件を明確
にします。

  * DORAによるメインブランチを使った開発の解説 — 小さな変更を頻繁に
統合する方法と、その影響を調べる手がかりです。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/engineering-best-practices/	engineer.company	70
