見やすい手順書を書くノウハウ集 - カミナシ エンジニアブログ

コーポレートエンジニアの@sion_cojpです。 コーポレートエンジニアをやってると、コード化できないものも多く、その場合は手順書を残す必要があります。 手順書は 「作業者が、上からなぞって実施していけば誰でも同じ作業になる」ために、見やすく書くノウハウをこの記事では紹介します。 1. 全体の文字数・1文の文字数・画像数をなるべく少なくする 2. インデントは2つまで。最悪3つ目まで 3. 危ない作業は赤文字 + 太文字で 4. 画像を使わず、なるべく文字だけで表現する 5. プロセス図に沿った手順を書く 6. 作業の流れだけを書く。ベストはコピペだけでできるように完結させる 7. 注意点はcalloutに書く 8. calloutが長くなればtoggleを使う 9. あまり発生しない手順はtoggleを使う 10. 分岐を極力少なくする 11. ひとつの画面で入力することが多い場合は、

[simplememofast]

確信はないけど、手順書術の核心は見やすさより『手順を消す』方では。分岐を潰しコード化して、手順書が要らない状態に寄せる。書く技術はその次なのかも

[Shinoryo11]

誰でも迷わず作業できる手順書を作るため、簡潔な表現や構造化、画像・分岐の抑制など、読みやすさと効率を追求する15のノウハウを紹介しています。

[pchatsu]

via https://x.com/sion_cojp/status/2068899972255474049

[yarumato]

“6. 作業の流れだけを書く。ベストはコピペだけでできるよう完結させる。　　クラウドサイン管理画面 にログイン→ 右上の名前→ 管理画面に移動→ 右上のメンバーを追加する　みたいな書き方分かりやすい”

[jacoby]

手順書に限らんけど、「組織として信頼できる最新版がどれか」、「改定するためにはどのような手順を踏むルールか」が組織で共有されていることも以外に重要。最新がどれかわからんでトラブルなりがち

[nguyen-oi]

『手順書がない状態が最高』というオチに尽きる。結局は自動化やSaaSのUI簡素化に勝るものはないんだよな

[sion_cojp]

書きました