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
810
うまくいくドキュメント運用の視点
しいたけ@shitake4
June 02, 2020
Tweet
Share
More Decks by しいたけ@shitake4
See All by しいたけ@shitake4
議論を進めるファシリテーション
shitake4
1
1.1k
Other Decks in Business
See All in Business
Connected Robotics
cr
1
55k
AI Transformation(AX) カンパニー紹介資料
algomatic
PRO
0
2.1k
フルカイテン株式会社 採用資料
fullkaiten
0
79k
目標の50記事を達成したわけだが
suzuki_tada
1
150
「要はバランス」を見極める - ADR実践で目指す技術的卓越への道 / It Depends: Practicing ADRs Toward Technical Excellence
ewa
0
650
【新卒向け】株式会社リブに興味のある方へ
libinc
0
9.8k
イークラウド会社紹介 ~挑戦で、つながる社会へ~
ecrowd
1
4.3k
MEEM_Company_Deck202512.pdf
info_meem
0
590
株式会社アペルザ_中途採用向け会社紹介資料
hr_team_aperza
4
140k
爆速入力が可能に! つよ〜い味方 Aqua Voice
panchaaan_2
0
210
NEXERA_ゲーム学習の未来
nexera
0
480
akippa株式会社|Company Deck
akippa
0
490
Featured
See All Featured
The Illustrated Children's Guide to Kubernetes
chrisshort
51
51k
Speed Design
sergeychernyshev
33
1.5k
Writing Fast Ruby
sferik
630
62k
AI: The stuff that nobody shows you
jnunemaker
PRO
1
150
Between Models and Reality
mayunak
1
160
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
21
1.3k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
141
34k
Self-Hosted WebAssembly Runtime for Runtime-Neutral Checkpoint/Restore in Edge–Cloud Continuum
chikuwait
0
270
Applied NLP in the Age of Generative AI
inesmontani
PRO
3
2k
Navigating the moral maze — ethical principles for Al-driven product design
skipperchong
1
220
Kristin Tynski - Automating Marketing Tasks With AI
techseoconnect
PRO
0
120
エンジニアに許された特別な時間の終わり
watany
106
220k
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