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
しいたけ@shitake4
June 02, 2020
Business
0
720
うまくいくドキュメント運用の視点
しいたけ@shitake4
June 02, 2020
Tweet
Share
More Decks by しいたけ@shitake4
See All by しいたけ@shitake4
議論を進めるファシリテーション
shitake4
1
900
Other Decks in Business
See All in Business
_HP掲載用_株式会社CloudSoft会社説明資料.pdf
csmatsushita
0
1.3k
WED Company Guide
wed
2
43k
re:Infrastructure_for the NextGen AI/ML and Beyond
ichichi
0
150
重厚長大なものづくり企業におけるプロダクトマネジメントの挑戦と苦悩 / pmconf2024
tkchy
0
4.9k
EM、会計を学ぶ
yigarashi
0
210
クロス・オペレーショングループ採用資料
xopg
2
24k
Amazon Q Developerの 最新アップデート情報まとめ
o2mami
0
1k
Ampersand Company Profile
cuebicventures
PRO
0
480
enechain company deck
enechain
PRO
8
94k
Creating Creators in the age of Generative AI - In SIGGRAPH ASIA 2024
o_ob
0
120
【After】サービス紹介資料③_HP掲載用
redeslide
0
480
職員給与等実態調査のDX
tokyo_metropolitan_gov_digital_hr
0
280
Featured
See All Featured
Dealing with People You Can't Stand - Big Design 2015
cassininazir
365
25k
Producing Creativity
orderedlist
PRO
341
39k
Documentation Writing (for coders)
carmenintech
66
4.5k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
507
140k
Building Adaptive Systems
keathley
38
2.3k
Writing Fast Ruby
sferik
628
61k
Into the Great Unknown - MozCon
thekraken
33
1.5k
Fight the Zombie Pattern Library - RWD Summit 2016
marcelosomers
232
17k
Rails Girls Zürich Keynote
gr2m
94
13k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
0
94
GraphQLの誤解/rethinking-graphql
sonatard
67
10k
The MySQL Ecosystem @ GitHub 2015
samlambert
250
12k
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