✅
成功するドキュメント管理の秘訣：チェックリスト
初めに
これまで携わってきたプロジェクトにおいて毎回ドキュメント管理がうまくいかずに困ってきました。
使いやすく効果的なドキュメント管理を実現するために、さまざまなプロジェクトがどのような工夫をしているのか、色々な記事を参考にして要点をまとめました。
使いやすいドキュメント管理チェックリスト
✅ ドキュメントを記載する目的を決めている
✅ 鮮度を保つドキュメント(ストック情報)と保たないドキュメント(フロー情報)を定義している
✅ 最新のドキュメントか判断が可能
✅ ドキュメント管理場所を判断するフロー[1]が誰もが見やすいように管理されている
✅ ドキュメントに書く内容・項目が事前に定義されている
✅ ドキュメントのハードルが低い(記述量が少ない、または自動化)
✅ 非エンジニアも参照可能である（必要に応じて）
✅ メンバーでレビューを経由するというプロセスがある
大事な意識
💬 ドキュメントは「価値を生む存在であると同時に、運用負荷も生む存在である」
💬 個人所有から共同所有への意識変換
参考にしたドキュメント管理記事
以下の記事を参考にして、効果的なドキュメント管理のポイントを整理しました
その他
よく使われるドキュメント管理ツール
-
GitHub Wiki
-
Confluence
-
Notion
-
Backlog
-
miro
-
Figma
-
esa
-
JIRA
Discussion