第4章:技術文体(曖昧さ排除・手順の書き方・例外系)
この章で学ぶこと
- 曖昧さ(条件/例外/数値/主語/期限)を排除する
- 手順は「検証と失敗時」まで書く
- 禁止事項と例外条件を明文化する
この章の成果物(または判断基準)
- 曖昧表現の置換ルール(例: 「適宜」を禁止)
- 例外系・失敗時の分岐を含む手順
本文
技術文書では「解釈の余地」が事故要因になる。手順の再現性は、数値・条件・主語で決まる。
典型の曖昧さ
- 適宜/必要に応じて
- なるべく/十分に
- 状況を見て
これらは条件/判断基準に置き換える。
具体例(悪い例→良い例)
悪い例
状況を見て再起動する。
適宜、設定を調整する。
良い例
次の条件を満たす場合に再起動する: 5分間エラー率>5% かつ ロールバック不能
設定は以下の値に変更する: timeout=30s
失敗時: ロールバック手順に従う
チェックリスト
- 条件(いつやるか)が数値/基準で書かれている
- 主語(誰がやるか)が明記されている
- 例外/失敗時の分岐がある
- 検証(成功条件)がある
まとめ
- 曖昧表現は条件/数値/期限/主語に置換し、解釈の余地を減らす
- 手順は検証・失敗時分岐・禁止事項まで含め、再現性を担保する
次章への接続
- 次章: 第5章