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
Sponsored
·
Ship Features Fearlessly
Turn features on and off without deploys. Used by thousands of Ruby developers.
→
しいたけ@shitake4
June 02, 2020
Business
830
0
Share
うまくいくドキュメント運用の視点
しいたけ@shitake4
June 02, 2020
More Decks by しいたけ@shitake4
See All by しいたけ@shitake4
議論を進めるファシリテーション
shitake4
1
1.1k
Other Decks in Business
See All in Business
TECTURE 採用資料 / We are hiring
tecture
1
6.5k
Sol Naciente_Try Out_質問項目
solnaciente
0
2k
VISASQ: ABOUT US
eikohashiba
16
570k
Staffing and Procurement for Fast Flow
mploed
1
120
AIエージェント時代のハーネスエンジニアリングとは
tame
4
2.9k
Nstock 採用資料 / We are hiring
nstock
30
370k
Global Vascular株式会社_会社紹介資料
globalvascular
0
340
Team Topologies as the 'infrastructure for agency' with humans and AI
matthewskelton
PRO
0
610
株式会社DFA Robotics - 会社説明資料
dfarobotics_inc
0
240
20260331更新_会社説明資料_slideshare_speakerdeck__.pdf
thecoo
0
270
神州電気/ 求職者向け会社紹介
mnaka
0
140
(5枚)共感力をアップする秘訣とは? 情動的共感と認知的共感の違いについて
nyattx
PRO
0
100
Featured
See All Featured
Distributed Sagas: A Protocol for Coordinating Microservices
caitiem20
333
22k
Typedesign – Prime Four
hannesfritz
42
3k
A Soul's Torment
seathinner
5
2.6k
How to train your dragon (web standard)
notwaldorf
97
6.6k
Design of three-dimensional binary manipulators for pick-and-place task avoiding obstacles (IECON2024)
konakalab
0
390
Google's AI Overviews - The New Search
badams
0
950
HDC tutorial
michielstock
1
600
The Illustrated Children's Guide to Kubernetes
chrisshort
51
52k
The Art of Programming - Codeland 2020
erikaheidi
57
14k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
287
14k
The Impact of AI in SEO - AI Overviews June 2024 Edition
aleyda
5
780
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
31
10k
Transcript
うまくいくドキュメント運用の視点 1
2 しいたけ(すずきたけし) @shitake4
ゴール 1 ドキュメント運用できている状態(理想)が分かる 2 理想の為に何を検討すればいいのか分かる 3
ドキュメント運用ができている状態 とは何か? 4
運用できてる状態 1 読み手がドキュメント管理ツールから情報を探せる 2 読み手がドキュメント管理ツールから情報を利用する 3 書き手がドキュメント管理ツールに情報を書く 5
運用できてる状態 ドキュメント管理 システム (Qiita Team, Notion等) ①情報を探す 書き手 読み手 ③情報を書く
②情報を利用 6
読み手が情報を利用するフロー 7
読み手の行動 情報を探す ドキュメン トを読む 使えるか 判断する 情報を 利用する 欲しい情報 がある
8
読み手が 情報の利用をあきらめる場合 9
探すのをあきらめる場合 情報を探す あきらめる 欲しい情報 がある あきらめる理由 欲しい情報が見つけられない 10
あきらめる 読むのをあきらめる場合 情報を探す ドキュメン トを読む 欲しい情報 がある あきらめる理由 ドキュメントがわかりにくい 11
あきらめる 利用をあきらめる場合 情報を探す ドキュメン トを読む 使えるか 判断する 欲しい情報 がある あきらめる理由
古い情報で参考にしかならない 12
まとめ 利用をあきらめる場合 1 欲しいものが見つからない 2 ドキュメントがわかりにくい 3 古い記事で参考にしかならない 13
まとめ 読み手の為の改善点 1 ドキュメントを探しやすくする 2 ドキュメントを読みやすくする 3 ドキュメントを最新の状態に保つ 14
書き手が情報を書くフロー 15
書き手の行動 記事を書く 共有する 書きたい という思い 情報を利用 してもらう 16
書き手が 情報を書かない場合 17
書きたい 理由がない 書かない理由 書かない理由 書きたい理由(インセンティブ)がない 18
あきらめる 書くのをあきらめる理由 あきらめる理由 どう書けばいいのかわからない 書きたい という思い 19
まとめ 書き手の為の改善点 1 ドキュメントを書きたくさせる 2 ドキュメントの書き方をわかってもらう 20
まとめ 改善点 1 ドキュメントを探しやすくする 2 ドキュメントを読みやすくする 3 ドキュメントを最新の状態にする 4 ドキュメントを書きたくさせる 5
ドキュメントの書き方をわかってもらう 21