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

SRE活動を促進させるドキュメント技術 〜ドキュメントレビューって、どうやってる?〜

Sponsored · Your Podcast. Everywhere. Effortlessly. Share. Educate. Inspire. Entertain. You do you. We'll handle the rest. →
Avatar for kenta_hi kenta_hi
May 16, 2024
Technology
490
1

SRE活動を促進させるドキュメント技術 〜ドキュメントレビューって、どうやってる?〜

渋谷でビール片手にLT会！【SREどうでしょう】 第3木曜LT会 #5 で話しました。

Avatar for kenta_hi

kenta_hi

May 16, 2024

More Decks by kenta_hi

See All by kenta_hi
AI × Incident Response: What ’s Next?
Avatar for kenta_hi kenta_hi
0
330
SREの組織類型に応じた リーダシップの考察
Avatar for kenta_hi kenta_hi
2
1k
SRE NEXT 2024 で形にした バトンを渡せる仕組み
Avatar for kenta_hi kenta_hi
1
210
SREの組織類型におけるリーダーシップの考察
Avatar for kenta_hi kenta_hi
3
3.2k
SRE Lounge #14 LT
Avatar for kenta_hi kenta_hi
0
510

Other Decks in Technology

See All in Technology
AI駆動1on1〜AIに自分を育ててもらう〜
Avatar for Yoshiaki Yasuda yoshiakiyasuda
0
120
自分のハンドルは自分で握れ！ ― 自分のケイパビリティを増やし、メンバーのケイパビリティ獲得を支援する ― / Take the wheel yourself
Avatar for TAKAKING22 takaking22
1
910
QGISプラグイン CMChangeDetector
Avatar for Forestgeo.info naokimuroki
1
400
Chasing Real-Time Observability for CRuby
Avatar for White-Green whitegreen
0
120
AIを共同作業者にして書籍を執筆する方法 / How to Write a Book with AI as a Co-Creator
Avatar for ama-ch ama_ch
2
130
AI時代 に増える データ活用先
Avatar for ono.takayuki takahal
0
230
Do Ruby::Box dream of Modular Monolith?
Avatar for Tomohiro Hashidate joker1007
1
340
マルチエージェント × ハーネスエンジニアリング × GitLab Duo Agent Platformで実現する「AIエージェントに仕事をさせる時代へ。」 / 20260421 GitLab Duo Agent Platform
Avatar for Niishi Kubo n11sh1
0
160
ハーネスエンジニアリングをやりすぎた話 ~そのハーネスは解体された~
Avatar for Gota gotalab555
4
1.7k
AI時代における技術的負債への取り組み
Avatar for Tadashi Shigeoka codenote
1
1.5k
こんなアーキテクチャ図はいやだ / Anti-pattern in AWS Architecture Diagrams
Avatar for Naomi Yamasaki naospon
1
450
Revisiting [CLS] and Patch Token Interaction in Vision Transformers
Avatar for yu4u yu4u
0
360

Featured

See All Featured
Learning to Love Humans: Emotional Interface Design
Avatar for Aarron Walter aarron
275
41k
What's in a price? How to price your products and services
Avatar for Michael Herold michaelherold
247
13k
Java REST API Framework Comparison - PWX 2021
Avatar for Matt Raible mraible
34
9.3k
Navigating Weather and Climate Data
Avatar for Ryan Abernathey rabernat
0
170
Amusing Abliteration
Avatar for ianozsvald ianozsvald
1
150
What Being in a Rock Band Can Teach Us About Real World SEO
Avatar for Ade Holder 427marketing
0
220
Pawsitive SEO: Lessons from My Dog (and Many Mistakes) on Thriving as a Consultant in the Age of AI
Avatar for David Carrasco davidcarrasco
0
120
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
Avatar for mongodb mongodb
49
9.9k
SERP Conf. Vienna - Web Accessibility: Optimizing for Inclusivity and SEO
Avatar for Sara Fernández Carmona sarafernandez
2
1.4k
Claude Code どこまでも/ Claude Code Everywhere
Avatar for nwiizo nwiizo
64
55k
The Anti-SEO Checklist Checklist. Pubcon Cyber Week
Avatar for Ryan Jones ryanjones
0
120
Reality Check: Gamification 10 Years Later
Avatar for Sebastian Deterding codingconduct
0
2.1k

Transcript

  1. SREの活動を促進させるドキュメントの技術 〜ドキュメントのレビューって、どうやってる？〜 @kenta.hi Topotal 2024/05/16

  2. © Topotal, Inc. 自己紹介 名前 : 菱田健太 (@kenta.hi) 会社 :

    Topotal 最近の活動 - SRE NEXT 2024 co-Chair - もう一度読むSRE - SRE as a Service 事例記事 - Waroom Meetup #1

  3. © Topotal, Inc. Topotalについて SRE as a Service Embedded SRE

    for customers

  4. © Topotal, Inc. 今日話すこと 1. 話すこと a. このLTのゴールは、文章をレビューする時に気をつける点がわかること です b.

    対象は、ドキュメントのレビューをする人です c. 文章の対象は、Issueやビジネスで利用する文章に限ります 2. 話さないこと a. 起承転結などの物語構成には対応しません b. 文法には言及しません

  5. © Topotal, Inc. it isn't done until it is documented

    1) 1) David N.Blank-Edelman.Becoming SRE. O’Reilly, 2024, 27P. テーマのきっかけ

  6. © Topotal, Inc. Topotalについて SRE as a Service Embedded SRE

    for customers 内製化を前提にSRE領域のコンサ ルテーションとエンジニアリングを提 供

  7. © Topotal, Inc. 読みやすいドキュメントに仕上げるための レビューの観点を共有します

  8. 読みやすいドキュメントにするために

  9. © Topotal, Inc. 読み手のほしい情報に過不足がない 自分が知ってる ドキュメントは、相手の知らない情報を自分の知ってる情報で埋め、行動を起こ す道具です。行動が起きない場合には、情報が不足しています。 相手が知ってる 相手が知らない 相手がわからない

    行動を起こす 結果 情報を 伝える

  10. © Topotal, Inc. 相手が知らない、相手がわからないを解消する 例えば、Why、What、Howのフレームワークで読んでも、わからないことがあります。これ は書き手が伝えるべき情報が認識できていないことに起因します。 各々で求められる情報の機能 情報の詳細 Why :

    なぜやるか（目的）とその理由を伝える機能です なぜやるか（目的） その理由 やる背景 What : 目的に対して目的を満たす方法を1つ選び、その理由を伝える 機能、また選ばなかった方法とその理由を伝える機能です 目的を満たす方法をあげる その選択肢を選んだ理由 ほかを選ばなかった理由 How : 選んだ方法を具体的な行動を伝える機能です 具体的な行動をあげる

  11. © Topotal, Inc. 読みやすいドキュメントって、どういうもの？？ 1. 読み手のほしい情報に過不足がない 2. 文章の構成が読み手に負担がない 読みやすいドキュメントは、2つの「ない」が必要です。

  12. © Topotal, Inc. 文章の構成が読み手に負担がない 読み手に負担がない構成は、文章を読み進めると情報が増えていく構成であることで す。例えば... 原文 端境となりやすい時期に天候不順が重なり、需給 が逼迫（ひっぱく）。 主要卸の1キロ価格は14日、ブロッコリー、キャベツ

    ともに平年の2.5倍を記録した。 特にブロッコリーは過去 5年間で最高値と、異例の 水準となっている。2) 読み進めると情報が増える文 ブロッコリーの価格が 14日に平年の2.5倍になった。 理由は天候不良と端境の時期が重なり、需給が逼 迫したため。 特にブロッコリーの2.5倍は、過去5年間で最高値で 異例の水準となる。 2) YahooJapan Newsより引用 https://news.yahoo.co.jp/pickup/6501108

  13. © Topotal, Inc. 文章の構成が読み手に負担がない 特にブロッコリーの2.5倍は、過去5年間で最高 値で異例の水準となる。 ブロッコリーの価格が14日に平年の2.5倍になった。 理由は天候不良と端境の時期が重 なり、需給が逼迫したため。 2.5倍の

    追加情報 主張の理由 の追加 主張や目的に対して様々な情報（理由や補足、反対意見の打消）が増えていくと、読み 手に負担がありません。

  14. © Topotal, Inc. ブロッコリーの価格が14日に平年の2.5倍になった。 理由は天候不良と端境の時期が重なり、需給が逼迫したため。 特にブロッコリーの2.5倍は、過去5年間で最高値で異例の水準となる。 文章の構成が読み手に負担がない レビュー側は、1つの文章がどのような機能を持っているかを確認しています。 2) YahooJapan

    Newsより引用 https://news.yahoo.co.jp/pickup/6501108 主張 主張に対する理由 補足情報

  15. © Topotal, Inc. おわりに 読みやすいドキュメントは、非同期で人を動かせる有益なツール です。みんなで読みやすいドキュメントを生み出していきましょう