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
750
うまくいくドキュメント運用の視点
しいたけ@shitake4
June 02, 2020
Tweet
Share
More Decks by しいたけ@shitake4
See All by しいたけ@shitake4
議論を進めるファシリテーション
shitake4
1
980
Other Decks in Business
See All in Business
(29枚)採用力アップトレーニングプログラムの詳細と3つの特徴
nyattx
PRO
0
260
社会の厳しさを知った壮年男性の物語
segavvy
1
670
Clear Inc. / we are hiring
clear_inc
0
32k
800本から見つかるベストセッション / Scrum Tokyo Douga Fight
aki_moon
1
110
セーフィー株式会社(Safie Inc.) 会社紹介資料
safie_recruit
6
330k
YADOKARI CULTURE DECK 2025
yadokari
0
570
(7枚)STAR法を活用した事例の書き方
nyattx
PRO
2
180
プロダクトは「好き」や「熱狂」にどう寄り添うか
tochiba
0
460
大城エネルギー 会社紹介スライド
daijyou
0
4.5k
fulltan_lt.pdf
icoriha
2
170
ご参考資料
ryoheig0405
1
200
Sales Marker Culture book
salesmarker
PRO
23
40k
Featured
See All Featured
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
135
33k
Raft: Consensus for Rubyists
vanstee
137
6.8k
How To Stay Up To Date on Web Technology
chriscoyier
790
250k
Git: the NoSQL Database
bkeepers
PRO
429
65k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
129
19k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
11
610
Intergalactic Javascript Robots from Outer Space
tanoku
270
27k
Imperfection Machines: The Place of Print at Facebook
scottboms
267
13k
Mobile First: as difficult as doing things right
swwweet
223
9.5k
Thoughts on Productivity
jonyablonski
69
4.5k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
7
620
Docker and Python
trallard
44
3.3k
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