うまくいった出力を、次に使えるよう保存する形を決めた

良い結果が出ても、次に再現できませんでした。何を残せばよいか整理した話です。

この記事の結論

  1. 出力だけ保存しても、次に再現できない
  2. 指示・条件・結果の3つを組で残す
  3. 何が効いたかを1行書くと、応用できる
  • 出力だけ保存しても、次に再現できない
  • 指示・条件・結果の3つを組で残す
  • 何が効いたかを1行書くと、応用できる

良い結果が出たとき、その出力だけ保存していた。次に同じことをしようとして再現できず、残し方を変えた。

出力だけでは足りない

結果だけ残しても、こうなった。

  • どう頼んだか思い出せない
  • 同じように頼んでも、違うものが返る
  • 何が効いたのか分からない

3つ目が本質だ。再現できないものは、知見として蓄積されない。

3つを組で残す

いまは、この3つを一組にしている。

  • 投げた指示の全文
  • そのときの条件(どのサービス、どの設定)
  • 返ってきた出力

2つ目を忘れやすい。サービスや設定が違えば、同じ指示でも結果が違う。

効いた点を書く

さらに、1行だけ考察を添えている。

  • 何が効いたと思うか
  • 前回と何を変えたか
  • 次に試すこと

1つ目は推測で構わない。書いておくと、次に検証できる。

保存する基準

何でも残すと探せなくなるので、基準を決めた。

  • 1回で満足な結果が出たもの
  • 何度も使いそうなもの
  • 失敗したが、理由が分かったもの

3つ目も残している。失敗の記録は、同じ失敗を防ぐ。

形式を揃える

探せるよう、書き方を固定した。

## (何をしたか)
日付 / サービス名

### 指示
(全文)

### 結果
(要点だけ。全文は長い場合がある)

### 効いた点
(1行)

結果は全文でなくてよい。再現できることが目的で、結果を保管することが目的ではない。

定型に昇格させる

溜まった記録から、定型を作っている。

  • 同じ指示を3回使ったら、定型にする
  • 定型は別のファイルに移す
  • 元の記録は、経緯として残す

3つ目を残しておくと、なぜその形になったか分かる。

結果が長い場合

出力が長いとき、何を残すか迷った。全文を保存すると記録が膨らむ。

  • 冒頭と末尾だけ残す。調子と結論が分かる
  • 特に良かった部分を、引用として抜く
  • 全文が要るものは、別のファイルに分けて置く

2つ目が実用的だった。残したいのは出力そのものではなく、どういう質のものが返ったかという目印だ。次に同じ指示を使ったとき、比べる基準があればよい。全文を残すと、記録を開くたびに長い文章を読み飛ばすことになる。

見返す仕組み

残しても見返さなければ意味がない。

  • 新しい作業を始める前に、似た記録を探す
  • 探すのは、記録を渡して聞く
  • 月に1度、全体を眺める

2つ目が効く。自分で検索するより、内容で拾ってもらうほうが見つかる。

保存する場所

どこに置くかも、運用の続きやすさに関わる。

  • 作業中に1手で開ける場所に置く
  • 検索できる形式にする。テキストが扱いやすい
  • サービスの中ではなく、手元に持つ

1つ目が守られないと、記録を取らなくなる。良い結果が出た瞬間に書かないと、その後は書かない。開くまでに3手かかる場所は、使われない場所だった。いまはファイル1つに追記するだけの形にしていて、開くのも検索するのも一瞬で済む。

残しすぎない

溜めすぎると、探すのが大変になる。

  • 半年使っていないものは消す
  • 定型に昇格したものは、元を整理する
  • 似た記録は、1つにまとめる

3つ目を定期的にやっている。同じ内容の記録が3つあっても、使うのは1つだ。

結果が再現しないとき

同じ指示を投げても、同じ結果にならないことがある。

  • 出力には幅があるので、完全な一致は期待しない
  • 方向が合っていれば、再現できたとみなす
  • 方向まで変わるなら、条件が違う可能性を疑う

3つ目を確認するようになった。サービスの版が変わっていたり、設定が違っていたりする。記録に条件を書いていると、ここで役に立つ。条件が同じなのに方向が変わるなら、指示そのものが曖昧だったということになる。その場合は、条件を1つ足して記録を更新している。

共有する形にする

人に渡せる形も意識している。

  • 自分の環境に依存する記述を外す
  • 書き換える箇所を示す
  • 何のための指示か、1行書く

渡せる形にしておくと、自分が半年後に見たときにも分かる。

まとめ

  • 出力だけ残しても、次に再現できない
  • 指示・条件・結果の3つを組で残す
  • 何が効いたかを1行書くと、次に検証できる
  • 失敗の記録も残す。同じ失敗を防ぐ
  • 3回使った指示は、定型に昇格させる

AUTHOR

北海道のWEB屋

北海道を拠点に、Web業界14年・サポート実績1,000件以上。WordPressの復旧、サーバー移転、独自ドメインとメールの設定、PHP・JavaScriptの修正まで対応します。相談と見積もりは無料です。

関連記事

RELATED