Upgrade to Pro — share decks privately, control downloads, hide ads and more …

手順書を作る側と使う側からの作成術

hutegmin
March 16, 2022

 手順書を作る側と使う側からの作成術

#手順書Night 第1回のLTでお話した資料です。
・使う側の視点
・作る側の視点
・まとめ
・おまけ(苦労話とブックリスト)

hutegmin

March 16, 2022
Tweet

Other Decks in Technology

Transcript

  1. 手順書の作成と更新の違い • 作成・・・0から作る場合 ◦ 手順書の最低限のルールを作成して誰でも簡単にかけるようにする ▪ バージョン管理のルール決め ▪ ファイルの命名規則決め ◦

    目次および階層構造をつくる(複数人で検討するほうがよい) ◦ 読み手や対象(管理者・利用者)の検討、粒度を読み手によって変更する • 更新・・・途中から引き継ぐ場合 ◦ 前任者の癖を把握し、書き手の癖を出さない ◦ 読みにくい読み進めにくいところは容赦なくリライトする ◦ 踏襲しつつも変更を躊躇わない ◦ 新規・追加事項は挿入場所をよく検討する、手順の流れを止めない 7
  2. 手順書を作成する技術 1~3 1なるべくシンプルにする ◦ 一文二義まで、できれば一文一義 ◦ 文と画像は1対1対応 ◦ 不要な文は削ぎ落とす 2付録をつける ◦

    CSV書式一覧、リンク集など 3文書ソフトの表をうまく使う ◦ ひとつの表でコピーペーストが必要なものをまとめる ◦ コマンドラインを背景黒で(印刷しない手順書前提)表示する ◦ 行頭を揃えたいものを無色の表で揃える 9
  3. コピーペーストしてもらいたいなにか 揃えたい なにか CPU ※※ OS Windows >ipconfig /all コンソールでの作

    業だとわかる 抜粋したほうが扱 いやすい インデントを 揃えやすく 10
  4. おまけ(手順書を作るにあたって学んだこと) • ブックリスト 一般財団法人テクニカルコミュニケーター協会 (2016)『日本語スタイルガイド(第3版)』, テクニカルコミュニ ケーター協会出版事業部 髙橋 慈子(2018)『技術者のためのテクニカルライティング入門講座』 ,翔泳社

    芦屋 広太(2020)『エンジニアのための文章術再入門講座 新版 状況別にすぐ効く!文書・文章作成の実 践テクニック』,翔泳社 樋口 恵一郎(2021) 『良いFAQの書き方──ユーザーの「わからない」を解決するための文章術』 ,技術評 論社 • オンライン Google Technical Writing Courses https://developers.google.com/tech-writing 16