Daily

綺麗で!探しやすい!ドキュメントのフォルダ構成にしよう!

こんにちは。だいらです。
要件定義書や見積もり、設計書・・・と業務を行なっていくうちにドキュメントはどんどん増えていきますね。
その時のフォルダ構成はどうでしょうか?ルートフォルダに要件定義書などのファイルがあったり、「〇〇の調査」などの個別のフォルダ、また「開発」などといった大きいまとまりのフォルダなどレベルの違った様々なものが作成されてませんか?
フォルダの構成をしっかりしないと、自分も他の人もドキュメントを探すときに迷ってしまいます。
業務を進める前にドキュメントのフォルダ構成をしっかりと決め、作って置くことが大切です。

まずは管理場所を決める

フォルダ構成の前に、これから行なっていく業務はどこで管理をするのか決めましょう。
まずは業務や会社などで決まっていることを洗い出します。

  1. 会社に定められているサーバーやサービスがある
  2. プロジェクト管理ツールなどを使用している
  3. 納品物のファイル形式

このような決まっている場合、選択肢が限られています。

会社に定められているサーバーやサービスがある

会社に定められているサーバーやサービスがある場合は、基本的にはその定められている場所から選択することになりますね。
自社サーバーや、GitHub、GitLabなどのGitリポジトリマネージャーまた、会社が契約しているグループウェアツールのGsuitやOffice365などがあると思います。

プロジェクト管理ツールなどを使用している

プロジェクト管理ツールは、Backlog、Trello、Redmineなど様々あります。
Redmineはオープンソースとして公開されているので、自社サーバーやクラウド環境に構築してプロジェクト管理をしている方が多いのではないでしょうか。
ファイルの共有や格納などができるツールもあるので、プロジェクト管理ツールでタスク管理、ファイル管理を一元管理するのも良いですね。

納品物のファイル形式

納品物のファイル形式が、お客様に指定されていたり、自社でドキュメントはWordとExcelで、と決まっている場合があります。
もし決まってないならば、MarkdownやHTMLといったマークアップ言語でドキュメントを作成しようとする方もいるのではないでしょうか。
その場合は、GitHub、GitLabなどのGitリポジトリマネージャーで管理するのもお勧めです。
バージョン管理や変更者の確認、またソースコードとの一元管理ができますし、プロジェクト管理ツールなどと連携できるサービスも出てきてます。

私の場合は、会社でGsuitを利用しているので基本的にはGoogleDriveを管理場所とし、ソースコードはGitLabで管理をしています。
ただ、このように格納場所を分ける場合は、同じファイルを別々の場所に置かないこととしてください。
2重管理になってしまい、更新しわすれで、片方だけが最新のようになってしまうリスクがあります。
必ず用途別に分けましょう。

フォルダ構成を決める

さて、格納場所が決まったら本題であるフォルダ構成を決めましょう。
フォルダ構成は、最初のルートフォルダに、フェーズごとのフォルダを作るのが良いです。
ではさっそく基本となる構成をご紹介します。

  • 00_管理
  • 10_見積
  • 20_要件定義
  • 30_設計
  • 40_開発
  • 50_試験
  • 60_マニュアル
  • 70_納品
  • 90_work

この構成はあくまで基本構造なので、業務により変更する必要があります。
たとえば、開発にはプログラムのソースコードなどが入りますが、GitLabで私は管理することが多いので、フォルダ構成にはいれないことが多いですね。

フォルダ構成のルール

さて、基本的な、ルートフォルダの構成をご紹介しましたが、業務を行いやすい構成にするのが一番良いです。
ここで、フォルダの構成を作る上で綺麗に、分かりやすくするための「ルール」をご紹介します。

先頭には、番号をつける

フォルダの先頭に採番することで、フォルダの並びをコントロールすることができます。
また、番号は10刻みで採番することで、後から間に追加を行いやすくなります。

  • 00_管理
  • 01_スケジュール ← 追加!
  • 10_見積

議事録と納品は日付フォルダを作成して格納する

議事録や納品物は、いつの会議か、いつ納品したのかを一目で分かるように、日付のフォルダに格納するのが良いでしょう。
日付は、年も分かるようにYYYYMMDDにします。

  • 納品
    • 20211030
    • 20211104
      • 設計書
      • ソースコード

管理すべきものはまとめておく

管理すべきものとは、マネジメント対象や、重要書類のことです。
色々あると思いますが、例としてスケジュール、借用書、貸出書、誓約書などがあります。
議事録もそうですね。
こういった重要書類は、分かりやすくするために管理フォルダにまとめることをお勧めします。
ただ、私の場合、スケジュールや議事録はアクセス頻度が高いので、以下のようにルートフォルダに置くことが多いです。

  • 00_管理
    • 借用書
  • 01_スケジュール
  • 02_議事録

「その他」フォルダは作らない

その他フォルダは、ファイルを入れる時、あまり思考せず放り込めるのでとても便利です。
ただ、このフォルダには「なにが入っているか」って名前を見ただけじゃ分からないですよね。
時間が経てば本人ですら、一度開いてみないとわからない、びっくり箱状態になります。
極力作らないようにしましょう。

フォルダ構成の意図を伝える

業務を行なっていく上で、一人で行う場合がありますが、メンバーがいることが多いと思います。
その場合は以下を共有しましょう。

  • なぜ、このような構成にしたのか
  • ほかに足りないものがあるか
  • 途中から、追加する場合はどうするか
  • こういう法則で使ってほしい

「途中から、追加する場合はどうするか」についてですが、リーダのみがフォルダ作成をおこなうのか、また、ルールを守ればチームのメンバーが各自で作っていいのかを決めておきましょう。

まとめ

ドキュメントの構成って適当になりやすいですが、ごちゃごちゃだと、ファイルが見つからなかったり、探すのに手間がかかって生産性が落ちてしまいやすいんですね。
少しルールを定めるだけでも、だいぶ分かりやすくなるのではないかなと思います。
では、綺麗で、分かりやすいフォルダ構成を作成し、快適なドキュメント管理をしましょう!

-Daily