コンテンツにスキップ

📄ドキュメント管理

必要に応じて各項目は調整する。

  • 概要
  • 背景
  • 目的
  • 適用範囲
  • 理由
  • 分類
  • 方法

ドキュメントの概要を記載する。

ドキュメントが必要になった背景を記載する。

何を達成しようとしているドキュメントなのか記載する。
再利用しやすくするため、1つのドキュメントは1つのテーマだけを扱う。

ドキュメントの内容が一部の範囲にのみ適用される場合はそれを記載する。

ドキュメントに意思決定やアクションプランの結論を含む場合、その経緯や理由も記載する。
記載されていないと結論を撤回したり方針を修正したりしにくくなるため。

チェスタトンのフェンス(フェンスが設置された理由を理解するまで撤去してはいけない)という考え方がある。
少なくとも当時はその結論が合理的だったはずなので、その理由を理解せずに撤回すると問題が生じる可能性が高い。
逆に、将来の意思決定のために理由を残しておく。

機密レベル および 更新頻度 でドキュメントを分類する。

ドキュメントを機密レベルに応じて適切に管理する。
アクセス制御、バックアップ、暗号化、廃棄などの方法をそれぞれ決めておく。

一般的には3段階の機密文書に機密でない文書を合わせて4つのレベルであることが多いが、組織によって変動する。
それぞれのレベルに含まれるドキュメントの種類も組織によって異なる。

  • 極秘文書
    • 経営に関わる情報や公開前の研究開発内容など
    • ごく一部の社員のみが参照可能
  • 秘文書
    • 契約書、人事情報、個人情報など
    • 一部の社員のみが参照可能
  • 社外秘文書
    • 企画書、議事録、顧客リストなど
    • 社員のみが参照可能
  • 公開文書
    • パンフレット、社内誌など
    • 社外にも公開可能

ドキュメントごとに適切な更新頻度で管理する。

  • 動的ドキュメント (dynamic document)
    • 継続的に最新の情報に更新するドキュメント
    • 仕様書、設計書、手順書、ルール、ガイドライン、ランディングページ、オンボーディング資料など
    • 最新かつ有効であることに責任を持つ ドキュメントオーナー を各動的ドキュメントに設定する
      • ドキュメントの先頭に「ドキュメントオーナー:〇〇」と記載するなど
    • 動的ドキュメントであることを明確にする
      • dynamic-document タグを付与するなど
      • どのドキュメントが最新であるかわかりやすくするため
    • 定期的に更新する
      • 少なくとも半年など
      • 情報が古くないか、不足している情報がないか、リンクが切れていないか、他のドキュメントと重複している内容がないかなどをチェックする
  • 静的ドキュメント (static document)
    • 継続的な更新はされないが、定期的に参照されるドキュメント
    • 議事録、アジェンダ、報告書、質問書、回答書、依頼書、提案書など
  • アーカイブ (archive)
    • 継続的な更新がされず、参照もほとんどされないドキュメント
    • 古いバージョンの動的ドキュメントや一定期間経過した静的ドキュメントなどはアーカイブする
      • 古いことが明確になるため
      • ツールによっては検索対象から除かれて、動的ドキュメントや静的ドキュメントの検索性が上がる
    • アーカイブする基準を決めておく

ドキュメントの内容を端的に表すタイトルにする。
また、ある時点の記録を記載したドキュメントはタイトルに日付を含める。

ブログやニュース記事などによく使われる、疑問文になっていたり長かったりするタイトルはどのようなドキュメントなのかがわかりにくい。
インプレッションを稼ぐために好奇心を煽る必要はない。

同じ情報が複数存在すると、どれかの更新が漏れたときに矛盾が生じる。すべて更新する場合は手間が増える。

1つのドキュメントに集約し、他のドキュメントからはリンクを張るようにする。

ドキュメントオーナー以外もメンテナンスする

Section titled “ドキュメントオーナー以外もメンテナンスする”

メンバー全員がドキュメントの改善意識を持つようにする。編集権限を全員に付与する。
ツールによってはコメント機能やレビュー機能があるため、それらを活用する。

定期的に同じタイプのドキュメントを作成する場合はテンプレートを用意する。
テンプレートによって作成コストが下がるだけでなく、構造が統一されることで読む際の認知コストも下がる。

  1. GitLabに学ぶ パフォーマンスを最大化させるドキュメンテーション技術 数千ページにもわたるハンドブックを活用したテキストコミュニケーションの作法 | 翔泳社
  2. Googleのソフトウェアエンジニアリング
  3. 明日から始める持続可能なドキュメンテーション戦略 / Sustainable Documentation Strategies: Documentation as a Product
  4. HTTPキャッシュに学ぶ、無理のないドキュメント更新運用
  5. Living document