1つのファイルに、1つのコマンド——QDが機能を小さく分けて作り、1つずつ確かめる理由
社内で使っている確認用のマクロが、いつの間にか1本の大きなプログラムになっている。1か所を直したいだけなのに、どこに響くか分からず、全部を確かめ直すことになる。そんな経験はないでしょうか。火曜日は、設計思想の回です。今日は、QDが守っている「1つのファイルに、1つのコマンド」という決まりについて書きます。
1か所を直すのに、全部を確かめ直すことになる
確認用のツールは、最初は小さく始まります。肉厚を測る、すき間を測る、抜き勾配を見る。便利なので機能が足され、気づくと1本のプログラムに何十もの確認が入っています。
こうなると、1つの確認を直すたびに、ほかの確認が変わっていないかを全部見直すことになります。どの機能がどの計算を使っているのかが、外から見えないからです。直す所は1つでも、確かめる所は全部。改修が重くなり、だんだん誰も触らなくなります。
// 1 つのファイルに 1 つのコマンド。計算は書かず、共通の計算を呼ぶだけ
export const command = {
name: '肉厚の確認',
deps: ['肉厚の計算', '面の法線'], // 使う共通の計算を宣言する
run(shape, rule, lib) {
const rows = lib['肉厚の計算'](shape); // 計算は共通の場所に 1 つだけ
return rows.map(r => ({
face: r.face,
value: r.thickness,
ok: r.thickness >= rule.min, // ここで決めるのは合否だけ
}));
},
};QDの決まり——1つのファイルに、1つのコマンド
QDでは、画面のボタン1つにあたる機能を「コマンド」と呼び、1つのコマンドを1つのファイルに収めます。コマンドの中でやることは決まっています。入力を受け取り、共通の計算を呼び、判定して、結果を数値・色・一覧で返す。それだけです。
距離や肉厚、断面といった計算そのものは、コマンドの中に書きません。計算は共通の場所に1つだけ置き、コマンドはそれを呼びます(この3層の分け方は#008で書きました)。だからコマンドのファイルは、画面と判定だけの小さなものになります。
ファイルを外せば、そのコマンドはQDから消えます。お客様にお渡しするときも、許可したコマンドのファイルだけを入れます。機能の単位と、ファイルの単位が同じなので、何が入っていて何が入っていないかが、ファイルの一覧を見れば分かります。
1つのコマンドに付くもの一式
1つのコマンドには、本体のファイルだけでなく、検証ケース20件・試験・アイコン・説明・画面の見本・品質の記録が一式で付きます。コマンドごとに、それ単独で試せて、直せて、お渡しできる状態にしておくためです。
検証ケースの20件は、基本・実務・境界・変形・異常に分けて用意し、期待する答えは式か別の方法で出します。今の出力を、そのまま正解にはしません(#003で詳しく書いています)。
直す所は1つでも、確かめる所は全部。
だから、1つずつに分けておく。
「単体でも同じ結果になるか」を、毎晩確かめる
小さく分けただけでは、まだ足りません。コマンドが、宣言していない計算にこっそり頼っていれば、外して使ったときに結果が変わってしまいます。
そこでQDでは、各コマンドが使う共通の計算を「依存」として宣言させています。毎晩の夜間ゲートでは、全部のコマンドをまとめて流したあと、もう一度、宣言した依存だけを読み込んで1つずつ流し、全体で流したときと同じ結果になるかを比べます。
今朝の夜間ゲートでは、404のコマンドを単体で流し、399が全体と同じ結果になりました。違いが出た5コマンドは、直す対象として記録に残っています。1つのコマンドが頼っている共通の計算は、多くが3〜5本でした。
お客様の側で変わること
1つのコマンドを直しても、ほかのコマンドの結果は変わりません。変わっていないことは、毎晩の単体の比較が示します。改修のたびに全部の確認をやり直す必要が、なくなります。
必要な確認だけを選んで使えます。金型まわりの確認だけ、板金の確認だけ、というお渡しのしかたができます。お渡しの最小の単位も、コマンドです。
作る側にとっても、1つのファイルには持ち主が1人です。何人かで並行して作っても、同じファイルを2人で同時に直すことはありません。お客様の判定基準に合わせた新しいコマンドも、ほかを止めずに足していけます。
今朝の数字——467のコマンドと、止めた2つ
今日の数字です。今朝4時33分に終わった夜間ゲートでは、コマンドは467(昨日の456から11増)で、実用が67、簡易が301、試作が90、未実装が9でした。未実装の9は、新しく足した検討の分野のコマンドで、これから中身を作ります。
段階が下がったコマンドが2つあり、ゲートはそれを止めました。止まったコマンドは、直して基準に戻るまでお渡ししません。止める仕組みが、1つのコマンドの単位で働いていること自体が、この決まりの効き目です。
QDで確かめられることの全体は、製品ページQRONIX QDにまとめています。毎回人が手で確かめている確認があれば、部品1〜2点と今の判定基準をお借りしてQDで回すところから始められます。ヒアリングと自働化設計書のご提案までは無料です。