「アウトプットしないのは知的な便秘」でおなじみの ssmjp です。
「ヤマサキ春のサメまつり 2021」で、 いろいろ間違って参加 してから、ちょこちょこ聞いております。
ちょこっとだけメモ取ったので、アウトプットしないで捨てるよりかは備忘録に置いときます。
セッション
真夏の夜の手順書トーク
@tcshさん,@nlog2n2さん,@togakushiさん
- 自動化好きな人は手順書嫌い
- 手順書書けない人の自動化はひどい
- そして負債化する
- CLIの手順書を出したらキャプチャーに置き換えられていった
- SIer とかだと辛いケース
- 手順書のコンテキストを意識
- ハイコンテキストだとやり直しが辛い
- 低コンテキストの手順にする
- 運用は事業継続のためのもの、そのための手順書
- 属人化をなくす
- 暗黙知を明示的な知識として知的財産化する
- 論理的な正しさを組み上げるプログラミング活動
- 非定常運用の手順書
- 実装できる部分は多いからすべき
- 緊急対応でも手順書は作れるはず
- 属人対応はOpen/Closeの基準とアウトライン程度でもすべき
- 手順書を放置して腐らせると、いざというときに使えない
- 体言止めはタイトルだけ
- タイトル以外は動詞をちゃんと使う
- 主語と目的語は省略しない
- 相対パスは使わない
所感
「自動化好きな人は手順書嫌い」と冒頭でありました。
仕様書がおいつかず、コードが仕様書になることはよくありますが、自動化されていればそこから読み取れるから 「自動化できるているだけマシじゃないかな？」と思いましたが、そんなことはないでしょうか？
手順書を陳腐化させずにメンテする大変さと、仕様書をメンテしていくのは同じような辛さですね。
エンジニアはだいたいドキュメント嫌いだけど、マークダウンなどのテキストで作成 + Git で管理にすると、比較的ハードル低く続けれる気がします。
