Upgrade to PRO for Only $50/Year—Limited-Time Offer! 🔥
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
SRE活動を促進させるドキュメント技術 〜ドキュメントレビューって、どうやってる?〜
Search
kenta_hi
May 16, 2024
Technology
1
340
SRE活動を促進させるドキュメント技術 〜ドキュメントレビューって、どうやってる?〜
渋谷でビール片手にLT会!【SREどうでしょう】 第3木曜LT会 #5 で話しました。
kenta_hi
May 16, 2024
Tweet
Share
More Decks by kenta_hi
See All by kenta_hi
SREの組織類型に応じた リーダシップの考察
kenta_hi
2
700
SRE NEXT 2024 で形にした バトンを渡せる仕組み
kenta_hi
1
110
SREの組織類型におけるリーダーシップの考察
kenta_hi
3
2.7k
SRE Lounge #14 LT
kenta_hi
0
440
Other Decks in Technology
See All in Technology
How is Cilium Tested?
yutarohayakawa
5
290
Nihonbashi Test Talk #3_WebDriver BiDiと最新の実装状況 / WebDriver BiDi latest status
takeyaqa
1
140
Replit Agent
kawaguti
PRO
2
170
TimeTreeが経た3つの転換点 ー プロダクト成長過程でその時、その瞬間、何を考えてたか
ysmtysts
1
3.4k
プルリクが全てじゃない!実は喜ばれるOSS貢献の方法8選
tkikuc
17
2.3k
Remix SPAモードのファイルベースルーティングで進めるフロントエンド構築
ryochike
0
160
asumikamというカンファレンスオーガナイザの凄さを語る / The Brilliance of Asumikam
tomzoh
1
290
AWS re:Invent 2024登壇資料(GBL206-JA: Unleashing the power of generative AI on AWS for your business)
minorun365
PRO
7
220
まだチケットを手動で書いてるの?!GitHub Actionsと生成AIでチケットの作成を自動化してみた話 / 20241207 Yoshinori Katayama
shift_evolve
1
750
ソフトウェアエンジニアとしてキャリアの螺旋を駆け上がる方法 - 経験と出会いが人生を変える / Career-Anchor-Drive
soudai
13
2.8k
クラウドネイティブへの小さな一歩!既存VMからコンテナまで、KubeVirtが実現する『無理しないペースの移行』とは!?
tsukaman
0
110
PostgreSQL Conference Japan 2024 A4 Comparison of column-oriented access methods
nori_shinoda
0
140
Featured
See All Featured
Put a Button on it: Removing Barriers to Going Fast.
kastner
59
3.6k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
6
480
A designer walks into a library…
pauljervisheath
204
24k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
356
29k
It's Worth the Effort
3n
183
27k
A better future with KSS
kneath
238
17k
GitHub's CSS Performance
jonrohan
1030
460k
BBQ
matthewcrist
85
9.3k
VelocityConf: Rendering Performance Case Studies
addyosmani
326
24k
The Art of Delivering Value - GDevCon NA Keynote
reverentgeek
8
1.2k
RailsConf 2023
tenderlove
29
920
No one is an island. Learnings from fostering a developers community.
thoeni
19
3k
Transcript
SREの活動を促進させるドキュメントの技術 〜ドキュメントのレビューって、どうやってる?〜 @kenta.hi Topotal 2024/05/16
© Topotal, Inc. 自己紹介 名前 : 菱田健太 (@kenta.hi) 会社 :
Topotal 最近の活動 - SRE NEXT 2024 co-Chair - もう一度読むSRE - SRE as a Service 事例記事 - Waroom Meetup #1
© Topotal, Inc. Topotalについて SRE as a Service Embedded SRE
for customers
© Topotal, Inc. 今日話すこと 1. 話すこと a. このLTのゴールは、文章をレビューする時に気をつける点がわかること です b.
対象は、ドキュメントのレビューをする人です c. 文章の対象は、Issueやビジネスで利用する文章に限ります 2. 話さないこと a. 起承転結などの物語構成には対応しません b. 文法には言及しません
© Topotal, Inc. it isn't done until it is documented
1) 1) David N.Blank-Edelman.Becoming SRE. O’Reilly, 2024, 27P. テーマのきっかけ
© Topotal, Inc. Topotalについて SRE as a Service Embedded SRE
for customers 内製化を前提にSRE領域のコンサ ルテーションとエンジニアリングを提 供
© Topotal, Inc. 読みやすいドキュメントに仕上げるための レビューの観点を共有します
読みやすいドキュメントにするために
© Topotal, Inc. 読み手のほしい情報に過不足がない 自分が知ってる ドキュメントは、相手の知らない情報を自分の知ってる情報で埋め、行動を起こ す道具です。行動が起きない場合には、情報が不足しています。 相手が知ってる 相手が知らない 相手がわからない
行動を起こす 結果 情報を 伝える
© Topotal, Inc. 相手が知らない、相手がわからないを解消する 例えば、Why、What、Howのフレームワークで読んでも、わからないことがあります。これ は書き手が伝えるべき情報が認識できていないことに起因します。 各々で求められる情報の機能 情報の詳細 Why :
なぜやるか(目的)とその理由を伝える機能です なぜやるか(目的) その理由 やる背景 What : 目的に対して目的を満たす方法を1つ選び、その理由を伝える 機能、また選ばなかった方法とその理由を伝える機能です 目的を満たす方法をあげる その選択肢を選んだ理由 ほかを選ばなかった理由 How : 選んだ方法を具体的な行動を伝える機能です 具体的な行動をあげる
© Topotal, Inc. 読みやすいドキュメントって、どういうもの?? 1. 読み手のほしい情報に過不足がない 2. 文章の構成が読み手に負担がない 読みやすいドキュメントは、2つの「ない」が必要です。
© Topotal, Inc. 文章の構成が読み手に負担がない 読み手に負担がない構成は、文章を読み進めると情報が増えていく構成であることで す。例えば... 原文 端境となりやすい時期に天候不順が重なり、需給 が逼迫(ひっぱく)。 主要卸の1キロ価格は14日、ブロッコリー、キャベツ
ともに平年の2.5倍を記録した。 特にブロッコリーは過去 5年間で最高値と、異例の 水準となっている。2) 読み進めると情報が増える文 ブロッコリーの価格が 14日に平年の2.5倍になった。 理由は天候不良と端境の時期が重なり、需給が逼 迫したため。 特にブロッコリーの2.5倍は、過去5年間で最高値で 異例の水準となる。 2) YahooJapan Newsより引用 https://news.yahoo.co.jp/pickup/6501108
© Topotal, Inc. 文章の構成が読み手に負担がない 特にブロッコリーの2.5倍は、過去5年間で最高 値で異例の水準となる。 ブロッコリーの価格が14日に平年の2.5倍になった。 理由は天候不良と端境の時期が重 なり、需給が逼迫したため。 2.5倍の
追加情報 主張の理由 の追加 主張や目的に対して様々な情報(理由や補足、反対意見の打消)が増えていくと、読み 手に負担がありません。
© Topotal, Inc. ブロッコリーの価格が14日に平年の2.5倍になった。 理由は天候不良と端境の時期が重なり、需給が逼迫したため。 特にブロッコリーの2.5倍は、過去5年間で最高値で異例の水準となる。 文章の構成が読み手に負担がない レビュー側は、1つの文章がどのような機能を持っているかを確認しています。 2) YahooJapan
Newsより引用 https://news.yahoo.co.jp/pickup/6501108 主張 主張に対する理由 補足情報
© Topotal, Inc. おわりに 読みやすいドキュメントは、非同期で人を動かせる有益なツール です。みんなで読みやすいドキュメントを生み出していきましょう