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
Shuma
April 25, 2024
52
0
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
誰にでも伝わる文書ってどんなものか考えた。
Shuma
April 25, 2024
More Decks by Shuma
See All by Shuma
DB移行、油断した瞬間に 肝が冷えた話
shubox
0
55
AIの権限設定に悩んでいる話
shubox
0
61
インフラ深掘りLT
shubox
0
59
飲食店長から_SREになった話
shubox
0
58
Ansible で Vector を導入し Slack 通知とログレベル色分けまでした話
shubox
0
63
阿部寛のホームページをSRE観点で改善出来るか考えてみた。
shubox
0
150
一日の終わりに、晩酌しながら眺めたいシステムログの世界
shubox
0
130
プロダクトがクローズした話
shubox
0
200
今も熱いもの!魂を揺さぶる戦士の儀式:マオリ族のハカ
shubox
0
330
Featured
See All Featured
Facilitating Awesome Meetings
lara
57
7.1k
The Mindset for Success: Future Career Progression
greggifford
PRO
0
450
Docker and Python
trallard
47
4.1k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
danielanewman
230
23k
Principles of Awesome APIs and How to Build Them.
keavy
128
18k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
28
3.6k
Conquering PDFs: document understanding beyond plain text
inesmontani
PRO
4
3k
Visual Storytelling: How to be a Superhuman Communicator
reverentgeek
2
620
Chasing Engaging Ingredients in Design
codingconduct
0
280
Build your cross-platform service in a week with App Engine
jlugia
234
19k
Agile that works and the tools we love
rasmusluckow
331
22k
Joys of Absence: A Defence of Solitary Play
codingconduct
1
440
Transcript
誰にでも伝わる文書ってどん なものか考えた。 発表者:Shuma
自己紹介 名前:Shuma (ただいま夏休み中) 職業:インフラ屋です。(プロダクト関連のインフラも社内の情シスもやります。) 勤務地:大阪 なにげ、今回3回目の参加です。 (大阪でも、エンジニアの輪あるのに全然行ってない。。。。 )
なぜ、この内容を敢えてやろうとしたのか?
結論 ・業務でエンジニア以外の人に文書作成し、伝える必要があったから。 ・技術者であっても、伝えるということが重要だとこの頃個人的に感じている。
前置き ・個人的な見解なので、果たしてすべてが正しいとは思ってないです。 ・記載している文書は社内に向けてのセキュリティリテラシー向上のために 書いている文書です。(OSのアップデート等も含みます。) ・今回は比較の為に、3つの実例を比較して説明していこうかなと思います。
ケース1(入社してスグに書いた社内通知文書)
全然、読んでもくれなかった。 振り返って考えてみるとダメだった部分として ・読みづらい ・こちら側から伝えたい重点な部分を強調してなかった。 ・手順とかを記載は別にマニュアル作成し、リンクを貼ればよかった。
ケース2(徐々に読んでもらえるようになった通知文書)
読んでも、もらえるように意識したこと。 ・文字数を減らし、要点をまとめる。 ・できるだけ、技術用語を使わずに ”なぜ、それをしないといけない”ということが重要視して記載する。 ・複数作業を実施してほしい場合は段落を分ける。
結果として、社内の人から反応がかえってくるように
ケース3、誰にでも起こりえることと想定して書く。 ・ケース2,も踏まえた上でさらに意識したことは 誰にでも仕事中やプライベートでもこのようなことは発生するんだということです。 ・Macなら大丈夫、iphoneなら大丈夫と思っている人が 社内にいたので危機意識をもってもらうように記載する。 (内容が多いので次のページに画像添付)
None
補足として ・3つのケースの中に、文書のなかに技術用語を記載しているやつもあるのですが、 通知文書とは別に、技術用語を分かりやすく解説した物も社内で発信しています。
None
自分なりに試行錯誤して考えて見た結果 社内通知文書作成する際に ・文字数は極力減らす。 →人間は文書の約20%しか見ない。と個人的に思う。 ・技術用語は極力使わないようにするが、 もし、使用したい場合は解説するドキュメント等を別で用意する。 ・あとは、分からない事があればいつでも聞いてと宛先を文末に記載する。 (誰でも、分かるように気を付けている部分があればぜひ教えてください!)
ご清聴ありがとうございました。