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
0
44
誰にでも伝わる文書ってどんなものか考えた。
Shuma
April 25, 2024
Tweet
Share
More Decks by Shuma
See All by Shuma
Ansible で Vector を導入し Slack 通知とログレベル色分けまでした話
shubox
0
26
阿部寛のホームページをSRE観点で改善出来るか考えてみた。
shubox
0
91
一日の終わりに、晩酌しながら眺めたいシステムログの世界
shubox
0
87
プロダクトがクローズした話
shubox
0
33
今も熱いもの!魂を揺さぶる戦士の儀式:マオリ族のハカ
shubox
0
250
信頼性工学とは? ~カツオを題材に~
shubox
0
100
バージョン管理と人生設計の類似点ver2 -リポジトリから学ぶ生きるヒント-
shubox
0
290
バージョン管理と人生設計の類似点
shubox
0
130
今年を振り返り、来年の抱負
shubox
0
280
Featured
See All Featured
Understanding Cognitive Biases in Performance Measurement
bluesmoon
32
2.8k
How To Speak Unicorn (iThemes Webinar)
marktimemedia
1
360
Self-Hosted WebAssembly Runtime for Runtime-Neutral Checkpoint/Restore in Edge–Cloud Continuum
chikuwait
0
270
SEO Brein meetup: CTRL+C is not how to scale international SEO
lindahogenes
0
2.3k
State of Search Keynote: SEO is Dead Long Live SEO
ryanjones
0
81
Are puppies a ranking factor?
jonoalderson
0
2.6k
Designing Experiences People Love
moore
143
24k
Build your cross-platform service in a week with App Engine
jlugia
234
18k
Odyssey Design
rkendrick25
PRO
0
450
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
4.1k
Documentation Writing (for coders)
carmenintech
77
5.2k
Organizational Design Perspectives: An Ontology of Organizational Design Elements
kimpetersen
PRO
0
51
Transcript
誰にでも伝わる文書ってどん なものか考えた。 発表者:Shuma
自己紹介 名前:Shuma (ただいま夏休み中) 職業:インフラ屋です。(プロダクト関連のインフラも社内の情シスもやります。) 勤務地:大阪 なにげ、今回3回目の参加です。 (大阪でも、エンジニアの輪あるのに全然行ってない。。。。 )
なぜ、この内容を敢えてやろうとしたのか?
結論 ・業務でエンジニア以外の人に文書作成し、伝える必要があったから。 ・技術者であっても、伝えるということが重要だとこの頃個人的に感じている。
前置き ・個人的な見解なので、果たしてすべてが正しいとは思ってないです。 ・記載している文書は社内に向けてのセキュリティリテラシー向上のために 書いている文書です。(OSのアップデート等も含みます。) ・今回は比較の為に、3つの実例を比較して説明していこうかなと思います。
ケース1(入社してスグに書いた社内通知文書)
全然、読んでもくれなかった。 振り返って考えてみるとダメだった部分として ・読みづらい ・こちら側から伝えたい重点な部分を強調してなかった。 ・手順とかを記載は別にマニュアル作成し、リンクを貼ればよかった。
ケース2(徐々に読んでもらえるようになった通知文書)
読んでも、もらえるように意識したこと。 ・文字数を減らし、要点をまとめる。 ・できるだけ、技術用語を使わずに ”なぜ、それをしないといけない”ということが重要視して記載する。 ・複数作業を実施してほしい場合は段落を分ける。
結果として、社内の人から反応がかえってくるように
ケース3、誰にでも起こりえることと想定して書く。 ・ケース2,も踏まえた上でさらに意識したことは 誰にでも仕事中やプライベートでもこのようなことは発生するんだということです。 ・Macなら大丈夫、iphoneなら大丈夫と思っている人が 社内にいたので危機意識をもってもらうように記載する。 (内容が多いので次のページに画像添付)
None
補足として ・3つのケースの中に、文書のなかに技術用語を記載しているやつもあるのですが、 通知文書とは別に、技術用語を分かりやすく解説した物も社内で発信しています。
None
自分なりに試行錯誤して考えて見た結果 社内通知文書作成する際に ・文字数は極力減らす。 →人間は文書の約20%しか見ない。と個人的に思う。 ・技術用語は極力使わないようにするが、 もし、使用したい場合は解説するドキュメント等を別で用意する。 ・あとは、分からない事があればいつでも聞いてと宛先を文末に記載する。 (誰でも、分かるように気を付けている部分があればぜひ教えてください!)
ご清聴ありがとうございました。