変更の記録は、1つの変更に1つのファイル——QDが、並べて作っても記録が取り合いにならないよう、変更ごとに別のファイルへ書き、夜に1本へ組み直す理由
火曜日は、QDの設計の考え方の回です。今回はコマンドの中身ではなく、変更の記録の置き方の話です。何をいつ、なぜ変えたかの記録は、作る人が増えるほど大事になります。ところが、その記録の置き方しだいで、記録そのものが開発を止める原因になります。
並べて作ると、最初にぶつかるのは記録だった
QDでは、変更を1件ずつ番号つきで記録しています。何を変えたか、なぜ変えたか、どのファイルを触ったか、お客様に配っている道具にどう当てるか。これを1つの表に1行ずつ足していく決まりで、10月の終わりまでに手で書いた変更の行は1,136行になっていました。
コマンドは1つのファイルに1つずつ分けているので、担当どうしが同じコードを触ることはほとんどありません。ところが、変更の表は全員が同じファイルの最後に1行を足します。コードは分けてあるのに、記録だけが全員の共有になっていたのです。
その結果、ある担当の変更を本線に合わせようとすると、その間に別の担当が表に足した行とぶつかります。1本の変更で2回、別の変更で1回、合わせ直しが起きました。直すのは数行でも、合わせ直すたびに、合わせる前の確認をもう一度最初から回すことになります。
なぜ起きるのか——1か所に足す決まりと、先に使った者勝ちの番号
ぶつかる理由は単純です。2人が同じファイルの同じ場所(最後の行)に、別々の行を足すからです。どちらの行も正しいのに、機械はどちらを先に置くか決められず、人が手で並べ直すことになります。
番号でも取り合いが起きました。新しい変更の番号は「今の表の最大+1」で決めていました。ところが、まだ本線に合わせていない作業の中で使った番号は、表には見えません。ある変更で使った番号を、あとから始めた別の変更が先に本線へ入れてしまい、最初の変更が番号を取り直したことがあります。
人が増えるほど、1か所に足す決まりは遅くなります。社内のマクロやツールでも、変更の一覧を1つのファイルや1枚の表で持っていると、同じことが起こり得ます。作る人が1人のうちは困らないので、気づくのは人が増えてからです。
QDの答え——変更1件に、ファイル1つ
10月27日から、QDは変更の記録の置き方を変えました。新しい変更は、変更ごとの置き場に「番号.md」という名前のファイルを1つ作り、そこに表の1行だけを書きます。別々の変更は別々のファイルになるので、2つの変更が同じ場所に足すことがありません。
番号は人が数えず、道具に取らせます。道具は、本線の表と変更ごとのファイルに加えて、まだ合わせていない作業の枝で使われた番号まで見て、その最大に1を足します。先ほどの取り合いは、合わせる前の番号が見えていなかったことが原因だったので、そこまで見るようにしました。
全員が読む1本の表は、なくしていません。手で書いてきた1,136行はそのまま残し、その下に、変更ごとのファイルの行を番号の順に並べて組み直します。1本の表は、人が書く物から、道具が作る物になりました。作る物なので、直接は書きません。
コードは分けてあるのに、
記録だけが全員の共有になっていた。
const fm = /^QCL-(\d+)\.md$/.exec(f), e = { file: DIR + '/' + f, id: fm ? 'QCL-' + fm[1] : null, line: lines[0] || '', err: [] };
if (!fm) e.err.push('ファイル名は QCL-<番号>.md');
if (lines.length !== 1) e.err.push('中身は表の 1 行だけ(今 ' + lines.length + ' 行)');
const m = ROW.exec(e.line);
if (!m) e.err.push('行は「| QCL-<番号> | 版 | 内容 | … |」で始める');
else if (fm && m[1] !== e.id) e.err.push('ファイル名(' + e.id + ')と行の番号(' + m[1] + ')が違う');
if (/(何をどう変えたか・なぜ)|(変えたファイル)/.test(e.line)) e.err.push('雛形のまま(( )の所を書き換える)');合わせる前に、数秒で確かめること
記録をファイルに分けると、別の間違いが起こり得ます。名前と中身の番号が違う、2行書いてしまった、雛形のまま出した、といった間違いです。そこで、本線に合わせる前の機械の確認の一番最初に、記録の形の検査を置きました。数秒で終わります。
確かめるのは、ファイル名が「番号.md」になっているか、中身が表の1行だけか、ファイル名と行の番号が同じか、雛形の書きかけが残っていないか、手で書いてきた部分の番号と重ならないか、同じ番号のファイルが2つないか、です。もう1つ、組み直した表の行が元のファイルの行と同じかも見ます。表を直接直すと、元のファイルと食い違うので、ここで見つかります。
逆に、変更ごとのファイルにはあるのに、まだ表に組み直されていない行は、間違いにしていません。作業の中では表を書かない決まりなので、本線の表は少し遅れてよいことにしました。記録を読む側の道具は、手で書いた部分と変更ごとのファイルを合わせて読むので、表が遅れていても同じ答えになります。
今日の数字——20晩、19本から290本まで
表の組み直しは、毎晩の品質ゲートの最後、写しを作る前に行っています。最初に組み直した10月29日の朝は、変更ごとのファイルは19本でした。今朝の11月17日は290本です。この20晩、組み直しはすべて「OK」で終わり、記録の形の検査で止まった晩はありません。11月15日の朝だけは、前の晩から新しい変更が無く、「変わりなし」でした。
本数の増え方は、開発の進み方そのものです。11月11日の朝の148本が、翌朝には226本になりました。1晩で78本の変更が入った日でも、記録どうしがぶつかって合わせ直す、という手間は起きていません。
今朝の品質ゲートでは、502のコマンドのうち実用が73、前の晩から段階が下がったコマンドは0でした。記録の置き方は、コマンドの品質とは別の話に見えます。けれども、合わせ直しの待ち時間が減った分だけ、確認と直しに時間を回せるようになっています。
import re
def check(files, manual_ids):
ng, seen = [], {}
for name, text in files.items():
lines = [l for l in text.splitlines() if l.strip()]
m = re.fullmatch(r'CL-(\d+)\.md', name)
if not m:
ng.append(name + ':ファイル名は CL-<番号>.md'); continue
if len(lines) != 1:
ng.append(name + ':中身は表の 1 行だけ'); continue
row = re.match(r'\| (CL-\d+) \|', lines[0])
if not row or row.group(1) != 'CL-' + m.group(1):
ng.append(name + ':ファイル名と行の番号が違う')
n = int(m.group(1))
if n in manual_ids:
ng.append(name + ':手で書いてきた部分と番号が重なる')
if n in seen:
ng.append(name + ':同じ番号が 2 つ')
seen[n] = name
return ng
def build(manual, files):
rows = sorted(files.values(), key=lambda t: int(re.match(r'\| CL-(\d+)', t).group(1)))
return '\n'.join(manual + ['', '(ここから下は組み直す部分)'] + [r.strip() for r in rows]) + '\n'
manual = ['| CL-1 | v1 | 最初の変更 |', '| CL-2 | v1 | 2 つ目の変更 |']
files = {'CL-4.md': '| CL-4 | v2 | 断面の色を変えた |\n',
'CL-3.md': '| CL-3 | v2 | 穴の一覧に深さを足した |\n'}
print(check(files, {1, 2}) or 'NG なし') # NG なし
print(build(manual, files), end='') # CL-1, CL-2 の下に CL-3, CL-4 の順
files['CL-2.md'] = '| CL-2 | v2 | 番号を取らずに書いた変更 |\n'
print(check(files, {1, 2})) # ['CL-2.md:手で書いてきた部分と番号が重なる']社内のツールで、今日から始められること
社内のマクロやツールで変更の一覧を持っているなら、まず、その一覧に何人が書いているかを数えてみてください。2人以上が同じファイルの最後に書いているなら、変更ごとに別のファイルに分け、一覧は道具で組み直す形にすると、ぶつかる場所がなくなります。
番号を使っているなら、番号を取る所を1つにまとめるのが先です。人が「今の最大+1」を数える限り、まだ見えていない番号と重なります。道具に取らせ、同じ番号が2つあれば機械が止める。この2つがあれば、人が増えても記録は取り合いになりません。
記事の上の動画は、QDの抜き勾配の確認です。今回の話はその手前の、作り方の話ですが、こうした1つ1つの確認のコマンドを並べて作り続けられるのは、記録の置き方まで含めた決まりがあるからです。
社内で作っているマクロやツールの、変更の残し方や配り方で困っていることがあれば、今の一覧を見せていただき、どこでぶつかるかを一緒に確かめています。ヒアリングと自働化設計書のご提案までは無料です。QDで確かめられることの全体は、製品ページQRONIX QDにまとめています。
記事一覧をすべて見る →