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
790
うまくいくドキュメント運用の視点
しいたけ@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
Rで学ぶデータハンドリング入門/Introduction_to_Data_Handling_with_R
florets1
0
100
straya/company deck
takuyaaaaa325
0
140
データ整備の「やり方」はどうなっていくか
shinu
PRO
2
420
ログラス会社紹介資料 / Loglass Company Deck
loglass2019
11
440k
社内LTで醸成する開発組織のアウトプット文化
tonegawa07
0
240
AIプロダクト時代のPdMに必要なコンテキストエンジニアリング
kayato
0
110
Sustainability Report
kuradashi
0
25k
プラスディーアンドシー合同会社 FACTBOOK _ver1.51_20250801
plusdc
PRO
1
230
TOKIUM 会社紹介資料
tokium
1
180k
佐賀県職員採用_ピッチスライド
sagasaiyou
0
1.9k
新規投資家向け資料
digitalgrid
0
1.2k
2025年10月副業制度運用者の実態調査
fkske
0
110
Featured
See All Featured
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
359
30k
Why You Should Never Use an ORM
jnunemaker
PRO
59
9.6k
Statistics for Hackers
jakevdp
799
220k
Optimizing for Happiness
mojombo
379
70k
Code Reviewing Like a Champion
maltzj
526
40k
Docker and Python
trallard
46
3.6k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
23
1.5k
RailsConf 2023
tenderlove
30
1.2k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
addyosmani
7
900
Speed Design
sergeychernyshev
32
1.2k
The MySQL Ecosystem @ GitHub 2015
samlambert
251
13k
Making the Leap to Tech Lead
cromwellryan
135
9.6k
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