【学問のすすめ】中世ヨーロッパ写字生のように黙って静かに手を動かすブログ

これまで習ったことや学んだことを記事にまとめています。ITネタが多いです。

【AIIT】PBL活動におけるファイル取扱規則の例

AIIT(産業技術大学院大学)のPBL活動で作ったファイルの取扱規則を紹介します。

PBL活動では、ドキュメントや動画、プログラム、スライドなどかなりの数のファイルを作成します。
作成したファイルはルールを決めて管理する必要があります(ルールを決めないとバージョン管理すらできなくなります)。 私たちの時は命名規則をはじめとしたファイル取扱規則を設定し、PMが作成したフォルダに保存することで整理しましした。

 

所属PBL

私が参加したPBL(研究室)は以下です。

  • 年度:2019年度
  • 専攻:情報アーキテクチャ
  • 科目:情報セキュリティ
  • ドキュメント種類:学会発表(論文/スライド)、調査報告書

 

ファイル取扱規則

ファイル保存先

ファイルはすべてGoogle Driveに設置した共有ドライブに保存します。(「共有フォルダ」ではない)

  • ドライブ名
    • XXPBL_YYYYチームフォルダ(例:写字生PBL_2019チームフォルダ)

 

フォルダ構成

Google Driveではフォルダを以下のような構成にしました。

  • XXPBL_YYYY_チームフォルダ (ルートデレクトリ)
    • 001_2018年以前のデータ
      • 先輩方のデータをまとめて保存
    • 002_整理前のファイルと中間成果物
      • 中間成果物各種を保存
      • 作業中のファイルはすべてここに保存し、このディレクトリで作業する
      • 完成したファイルは「成果物」フォルダにコピーする(オリジナルデータはここに残す)
    • 004_参考データ
      • 参考になるファイルを保存
      • 各機関の報告書/電子ジャーナル/プログラムファイルなど
    • 005_バックログ登録済資料
    • 006_成果物
      • 各Qの成果物を保存
      • 諸事情によりバックログに登録しないものも含める
    • 999_成果物受け渡し用フォルダ
      • 成果物の受け渡しに使用

ディレクトリ構成はPMが管理し、メンバーから要望があった場合に変更する方式をとっていました。 PBL開始当初は他にも多くのフォルダがありましたが、メンバーから「数が多くてわかりにくい」と指摘があったため数を減らし、上記に落ち着きました。

 

ファイル編集の手順

ファイル編集の手順は以下の通り。

  1. 中間成果物フォルダにファイル命名規則に準拠したファイルを保存する。(まずファイルを保存する)
  2. Google Drve File Streamの中間成果物フォルダないでファイルを開き、編集する。
  3. ファイルを上書き保存する。

※既存ファイルを編集する場合は最初にバージョン番号を更新したファイルを保存し、そのあとで編集する。

 

ファイルの整理について

ファイルは以下の規則に従い整理する。

  • 成果物として登録するファイルはフォルダ「006_成果物」にその時点の最新版をコピーする
  • バックログに登録するファイルはフォルダ「005_バックログ登録済資料」にコピーする(Backlog上のファイルを更新した場合はフォルダ内のファイルも更新する)
  • タスクリスト/プロジェクト計画書などPBL運営のための資料はフォルダ「003_PBL管理ドキュメント」に保存する
  • 先輩方の作成したファイルは参考資料としてフォルダ「001_2018年以前のデータ」に保存する
  • 「中間成果物フォルダ」内のファイル数が多くなった場合は、PMが不要なファイルをフォルダ「000_過去ファイルおよび使用済ファイル」に移動させる
  • 各クオータごとの成果物はフォルダ「100_1Q成果物」のようなクオータごとに作成するフォルダに整理して保存する

 

ファイル命名規則

ファイル作成時もしくは更新時は以下の規則に従いファイル名を設定する

  • 命名規則:ファイル名学生識別記号管理番号払い出し番号(2桁)-バージョン番号(2桁)_コメント
  • 例:定例会議事録_t190628_01-01_XX作成.docx (田中の作成した2019年6月28日の定例会議事録バージョン1)

【学生識別記号例】

  • 田中:t
  • 山田:yd
  • 佐藤:st
  • 鈴木:sk
  • 伊藤:i
  • 山口:yg

管理番号は下記の規則に従い設定する。

  • 管理番号:西暦(下2桁) & 月(2桁) & 日(2桁)
  • 例:190608 (2019年6月8日)

作成した資料には左上にバージョン番号を除いた管理番号と払い出し番号を記載する。

  • 例: 管理番号:t190628_01

 

Google Drive Fire Streamの利用について

Google Drive Fire Streamは、Google Driveとのファイル送受信を効率化するソフトウェアである。
ローカル環境とGoogle Driveを連結し、クラウド上のファイルをローカル上のファイルと同様に取り扱うことができる。

私たちのPBLでは主に下記の用途に使用する。

Google Drive File Streamは下記の公式ページよりダウンロードすることができる。

■ドライブ ファイル ストリームを導入する
https://support.google.com/a/answer/7491144?hl=ja

support.google.com

ページに設置されているダウンロードURLは下記の通り。

Windows
https://dl.google.com/drive-file-stream/GoogleDriveFSSetup.exe

Mac
https://dl.google.com/drive-file-stream/GoogleDriveFileStream.dmg

ダウンロード・インストールののち、学校で使用しているアカウントでログインすることで利用可能となる。

注1:AIITでは全学生/科目履修生にG Suiteのアカウントが配布され、卒業後も10年間使用できる。
注2:Google Drive File Stream 利用開始直後は一時的にパソコンの動作が不安定になる

 

補足

規則の管理について

PBL開始後2週間程度でファイル取扱規則を定め、Backlog(PBLで使うプロジェクト管理システム)のWikiページに掲載しました。 1年程度この内容で運用しました、途中フォルダ構成をシンプルにしましたが、それ以外の変更はありませんでした。

 

保存したファイルの取り扱い

「成果物フォルダ」には完成品のファイルを保存します。
各クオーターの終わりに成果物をHDDに保存し教員に提出していました。 一度ファイルはローカルにダウンロードしてからHDDにコピーするのにかなり時間がかかります。 結局提出がギリギリアウトになることも数回ありました。

 

感想

学校で使うGoogle Driveは容量が無制限なこともあり、数GBのOSイメージから数百KBのドキュメントまでまとめて管理することができました。 最後までこのやり方で問題なく運用することができました。ルールとしては優れていると思います。

注:途中、教員からファイル命名規則の変更を指示されましたが、大した問題ではありません。