Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up for free
うまくいくドキュメント運用の視点
しいたけ@shitake4
June 02, 2020
Business
0
430
うまくいくドキュメント運用の視点
しいたけ@shitake4
June 02, 2020
Tweet
Share
More Decks by しいたけ@shitake4
See All by しいたけ@shitake4
議論を進めるファシリテーション
shitake4
1
570
Other Decks in Business
See All in Business
製品・サービスの導入検討に関するアンケート調査報告書
gakumarketing
PRO
0
230
機械学習エンジニアが目指すキャリアパスとその実話 / My Journey to Become a ML Engineer
shinyorke
4
6.2k
株式会社クロスビット_culture deck
xbit
2
6.1k
UP Life(生活習慣病予防・改善特化型デイサービス)施設紹介資料
up_life
0
150
「分析組織でデータエンジニア組織を立ち上げた話」(バンダイナムコネクサス藤井 祐麻さん)
jdmc
0
160
KPIマネジメントの重要指標の決め方がわかる資料
nyattx
PRO
1
340
230117 DX人材・デジタルスキルについて_株式会社コミュカル Mitz
comucal
PRO
1
540
キャンつく Instagram版
pickles_staff
0
42k
Twitter Instagram キャンペーンツール「キャンつく」
pickles_staff
0
44k
チームのパフォーマンスを引き出す、ワクワクするプロダクトゴール、OKR / Waku-waku Product Goal and OKR
navitimejapan
PRO
9
6.9k
動かない部下を確実に動かす方法がわかる資料
nyattx
PRO
1
1.3k
コトラのことが5分でわかる! | 株式会社コトラ説明資料
kotora
21
4.9k
Featured
See All Featured
Build your cross-platform service in a week with App Engine
jlugia
221
17k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
349
27k
Web Components: a chance to create the future
zenorocha
304
40k
Happy Clients
brianwarren
90
5.8k
Why You Should Never Use an ORM
jnunemaker
PRO
49
7.9k
Making Projects Easy
brettharned
102
4.8k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
120
29k
Designing with Data
zakiwarfel
91
4.2k
Building an army of robots
kneath
301
40k
5 minutes of I Can Smell Your CMS
philhawksworth
198
18k
Visualization
eitanlees
128
12k
Bash Introduction
62gerente
601
210k
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