Upgrade to PRO for Only $50/Year—Limited-Time Offer! 🔥
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
フロントエンドにおける「型」の責任分解に対する1つのアプローチ
kinocoboy2
5
1.6k
OH MY GOD inc. 会社概要
fujiyamayuta
0
24k
実体験:エンジニアの妊娠・出産と仕事/real-life-experience-pregnancy-childbirth-and-work-for-engineers
emiki
9
1.8k
ログラス会社紹介資料 新卒採用 ビジネス職[経営幹部候補]/ Loglass Company Deck
loglass2019
1
13k
不感対策ソリューション 詳細資料
jtes
0
350
インキュデータ会社紹介資料
okitsu
3
47k
FREEDOM株式会社 会社紹介資料
fdyabe
0
540
Crisp Code inc.|コーポレート・サービス紹介 - Corporate & Services Introduction
so_kotani
0
370
[登壇レポート]リユースDX再前線〜既存データの整備とECへの活用で加速する事業成長〜
takahashikazuo
0
100
株式会社エンミッシュ 採用資料
enmish
1
380
メドピアグループ紹介資料
medpeer_recruit
10
140k
Fintech landscape updated - Japan section
hakusansai
0
1.1k
Featured
See All Featured
4 Signs Your Business is Dying
shpigford
186
22k
Become a Pro
speakerdeck
PRO
31
5.7k
Build your cross-platform service in a week with App Engine
jlugia
234
18k
Why You Should Never Use an ORM
jnunemaker
PRO
61
9.6k
Art, The Web, and Tiny UX
lynnandtonic
303
21k
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
4.1k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
21
1.3k
The Art of Programming - Codeland 2020
erikaheidi
56
14k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
31
9.8k
Intergalactic Javascript Robots from Outer Space
tanoku
273
27k
Agile that works and the tools we love
rasmusluckow
331
21k
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
32
1.8k
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