Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
手順書を作る側と使う側からの作成術
Search
hutegmin
March 16, 2022
Technology
1
1.1k
手順書を作る側と使う側からの作成術
#手順書Night 第1回のLTでお話した資料です。
・使う側の視点
・作る側の視点
・まとめ
・おまけ(苦労話とブックリスト)
hutegmin
March 16, 2022
Tweet
Share
Other Decks in Technology
See All in Technology
現実世界の事象から学ぶSOLID原則
h0r15h0
24
10k
Ask-LLM論文紹介: How to Train Data-Efficient LLMs
s_ota
0
110
Elementaryを用いたデータ品質の可視化とデータ基盤の運用改善
10xinc
6
1.4k
技術広報として2023年度に頑張ったこと / What we did well in FY2023 as a DevRel
pauli
5
460
統計的学習理論読み Chapter 2
kmatsui
1
190
#51 “Empowering Azure Storage with RDMA”
cafenero_777
3
210
OCI Data Integration技術情報 / ocidi_technical_jp
oracle4engineer
PRO
1
1.5k
関数型DDDの理論と実践:「決定を遅らせる」を先につくり、 ビジネスの機動力と価値をあげる
knih
2
470
エバンジェリスト活動を7年やってきて見えてきた、コミュニティとエバンジェリストの関係
soracom
PRO
1
200
Vos logs méritent mieux que la config par défaut
lyrixx
2
250
既存プロセスからの脱却と変化に適応するために必要なこと
cybozuinsideout
PRO
2
170
大規模なアジャイル開発の現場と技術負債 / Technical Debt
yoshiitaka
20
4k
Featured
See All Featured
Gamification - CAS2011
davidbonilla
76
4.5k
Navigating Team Friction
lara
177
13k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
1
1.2k
Statistics for Hackers
jakevdp
789
220k
The Brand Is Dead. Long Live the Brand.
mthomps
48
21k
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
18
1.7k
Ruby is Unlike a Banana
tanoku
95
10k
Building Your Own Lightsaber
phodgson
97
5.6k
Six Lessons from altMBA
skipperchong
19
2.9k
Put a Button on it: Removing Barriers to Going Fast.
kastner
58
3k
Music & Morning Musume
bryan
39
5.5k
Adopting Sorbet at Scale
ufuk
66
8.5k
Transcript
手順書を作る側と 使う側からの作成術 第1回手順書Night めぐみ 1
今宵のLTの内容 1. 使う側の視点 2. 作る側の視点 3. まとめ 4. おまけ 2
使う側
使う側としての視点 • 使う側として手順書を読むまたは使う場合 ◦ 誰がやっても同じ結果になる ◦ 自分が必要な情報にたどり着きたい(検索性と見出しと階層構造が大事) ◦ 更新頻度は必要に応じて高いほうがありがたい ◦
作成者には気づいた点を共有する、フィードバックを行う 4
作る側
手順書作成のフロー 1. 作成依頼・更新依頼が届くまたは更新したい箇所が発生する 2. 作成する・共同編集する、できれば作成するメンバーでコメントベースでの レビューを行う 3. レビュー係に手順書をPDFで渡す 4. レビューからの指摘と修正箇所の訂正の繰り返し
5. 校了 6. 判定・承認 7. 公開や展開および共有の手続き 6
手順書の作成と更新の違い • 作成・・・0から作る場合 ◦ 手順書の最低限のルールを作成して誰でも簡単にかけるようにする ▪ バージョン管理のルール決め ▪ ファイルの命名規則決め ◦
目次および階層構造をつくる(複数人で検討するほうがよい) ◦ 読み手や対象(管理者・利用者)の検討、粒度を読み手によって変更する • 更新・・・途中から引き継ぐ場合 ◦ 前任者の癖を把握し、書き手の癖を出さない ◦ 読みにくい読み進めにくいところは容赦なくリライトする ◦ 踏襲しつつも変更を躊躇わない ◦ 新規・追加事項は挿入場所をよく検討する、手順の流れを止めない 7
手順書を 作成する 5つの技術
手順書を作成する技術 1~3 1なるべくシンプルにする ◦ 一文二義まで、できれば一文一義 ◦ 文と画像は1対1対応 ◦ 不要な文は削ぎ落とす 2付録をつける ◦
CSV書式一覧、リンク集など 3文書ソフトの表をうまく使う ◦ ひとつの表でコピーペーストが必要なものをまとめる ◦ コマンドラインを背景黒で(印刷しない手順書前提)表示する ◦ 行頭を揃えたいものを無色の表で揃える 9
コピーペーストしてもらいたいなにか 揃えたい なにか CPU ※※ OS Windows >ipconfig /all コンソールでの作
業だとわかる 抜粋したほうが扱 いやすい インデントを 揃えやすく 10
手順書を作成する技術 4~5 4言葉がぶれないようにする ◦ 用語集を作成する(書き手の共通言語、俗語や省略語も正式名に) ◦ 開発者や技術者が使うことばを専門用語から一般用語へ落とし込む (例:デフォルト→初期設定や初期値) ◦ 固有名詞や専門用語は必ず初出のときに補足を書く 5文書ソフト・アプリの機能を使いたおす
◦ 文や単語を揃える・目次挿入などは機能をうまく使う ◦ 見出し機能や検索や置換は人の目や手に頼らない、正規表現を使 えるとなおよし。 11
まとめ
手順書を作る側でありながら、使い手にイン タビューを行い、改訂時にフィードバックを活 かす 使う側の視点があるからこそ、作る側はもっ といい手順書をつくることができる 13
おまけ
おまけ(作り手としてしんどいこと) • ユーザーインターフェースや細部のボタンなどが変更になった際の画面差 し替え(工数がかなりかかる、腱鞘炎の原因になりうる) • コマンドが古くなった際の変更(裏付けを取る工数が地味にかかる) • 繁忙期の現場業務と手順書作成の納期が同じ期間にある場合の両立 • 具体策のない改善要望(汲み取るのが難しい、その人固有の考え方であ
ることが少なくない) • 意図が読み取りにくい指摘事項(指摘する側も基本的な文章添削能力が ないと陥りやすい) 15
おまけ(手順書を作るにあたって学んだこと) • ブックリスト 一般財団法人テクニカルコミュニケーター協会 (2016)『日本語スタイルガイド(第3版)』, テクニカルコミュニ ケーター協会出版事業部 髙橋 慈子(2018)『技術者のためのテクニカルライティング入門講座』 ,翔泳社
芦屋 広太(2020)『エンジニアのための文章術再入門講座 新版 状況別にすぐ効く!文書・文章作成の実 践テクニック』,翔泳社 樋口 恵一郎(2021) 『良いFAQの書き方──ユーザーの「わからない」を解決するための文章術』 ,技術評 論社 • オンライン Google Technical Writing Courses https://developers.google.com/tech-writing 16