ドキュメントへの挑戦 ～チームで築く情報資産 by Shu Oogawara

概要

チームに必要十分なドキュメントを準備するのは非常に難易度が高いタスクです。

メンバーが個々に知見を残していくボトムアップのアプローチには、必要な情報が網羅されていることを保証できないという欠点があります。一方でトップダウンのアプローチを取ると、メンバーの工数を確保し参加を促すのが難しいという課題があります。

さらに、ドキュメントの質の担保や作成したドキュメントの陳腐化などはいずれのアプローチを取っても避けられない問題です。

しかし、我々のチームは一定の質を担保しながら必要十分な情報が揃ったドキュメントを企画から1年近くかけて作り上げ、その後も継続的にメンテナンスを行っています。

本セッションでは、ドキュメント構築の過程を追いながら以下の内容について説明していきます：

• ドキュメントの全体構成・文書作成ガイドライン・テンプレートの策定
• ドキュメント作成およびレビューのパイプライン
• 文書の陳腐化を防ぐためのしくみと活動

Learning Outcome

対象

チームにドキュメントの必要性を感じているが、どのように進めればよいか悩んでいる方

得られるもの

組織的なドキュメント作成に関する以下のノウハウ：

• ドキュメントの全体構成をどのような観点から考えるか
• 読まれることを前提にテンプレートをどのように設計するか
• 記事の作成とレビューを行うためのガイドラインをどのように決めるか
• 記事の作成をどのように手分けして進めるか
• 記事の陳腐化をどのように防ぐか