手順書を作るときに意識していること

2024/12/14　Kawaii♡LTで発表した資料。

Transcript

1. 手順書を作るときに意識している こと 2024/12/14 Kawaii♡LT
2. 自己紹介 • 影中 光（かげなか ひかり） • 自社製品のWebサービス開発 • JAZUG for Women運営 • 好きな服：膨らんでるスカート。クラシカルなもの。華ロリ。 • X(旧Twitter)：@_mi_lin_
3. 今日の目的 • 手順書を作るときに意識していること紹介すること！ • 対象→チーム内で属人性を排除するために共有する手順書 • 対象外→製品マニュアル、仕様書など ひとつでも参考になる ことがあったら嬉しい！
4. 手順書作成時に考えていること 頼む～～～～～ 伝わってくれ～～～～～ ～～～！！！ これを言語化してみた
5. トピック • 前提の意識 • 文章で気を付けていること • 構成で気を付けていること
6. 前提の意識 • 自分の言語能力はとても低いと自覚する！（実際がどうかは関係ない • 何も対策せずに話すと5人中1人にしか伝わらないと思う。 • 5人中5人に伝わることを目指す。 • 伝わるように伝えるのが伝える側の責務。 • 「伝わらないのは受け手側の問題だ！」はなし。 • 伝わらなければ何も伝えてないのと一緒。 手順書に限らず、 報告・連絡の文章も同じく 意識します
7. 手順書とは 誰がいつ見ても同じ作業ができるもの 【イメージする人】 ・未来の自分 ・初めてチームに参加する 人 【イメージする時】 ・やろうと思ったときに手順 書を開けばできる ・事前準備不要
8. 文章として気を付けていること • 複数の解釈が生まれないように書く • 1文をシンプルにする
9. 複数の解釈が生まれないように書く • 対象が一意に特定できるように書く • 代名詞や指示語は使わない • 文脈でわかることも端折らない • 例） ×サインインする。 〇GitHubのアカウントでサインインする。
10. 一文を短くする • 目的語と述語を明確にする • 「何を何する」の羅列だけでいい • 補足や注意事項などは文章を分ける
11. 構成として気を付けていること • 目的 • 前提条件 • 自分がやった作業をトレース • 付録
12. 目的を書く • 書き手側のメリット • 書く内容の指標になる • 「何のために書いてるんだっけ？」がなくなる • 読み手側のメリット • 何のための手順かが分かりやすいと心構えができる
13. 前提条件を書く • 手順を実施するうえで必要な環境・準備を書く • 自分のチーム向けだとあんまり意識しない • チーム外に渡す手順書の場合、誰がどんな環境で実施するかわからないので 必須 • 例）実施するアカウント情報、デバイス情報、必要な資材
14. 自分がやった作業をトレースする • 同じ作業が再現できるようにする • 情報の粒度が大→中→小になるようにする • 作業時に取得したキャプチャがあると楽 • 言語優位な人だけでなく、視覚優位な人にも伝わりやすくなる
15. 付録をつける • 実際に使用したファイルなどがあれば添付する • 例）CSVファイル、SQLクエリ
16. 最後まとめ • 伝わるように伝えることを意識する • 複数の解釈が生まれないようにする • 端的に書く • 目的、前提条件を忘れない
17. ご清聴ありがとうございました