卒業・修了時の研究の引き継ぎについてのメモ

大学

主にソフトウェア開発の研究について

研究に使ったソフトウェアおよびその実行環境について

作ったソフトウェアのソースファイルを残しておくのは大前提として、実行環境の構築方法も残してもらわないと困ることが多い。

  1. Windows, Mac OS, Linux などの標準インストール後の状態からどうやって実行環境を構築するかについてのドキュメント
  2. （可能な限り）実行環境構築に使用したソフトウェアのソースファイル
  3. 作ったソフトウェアのソースファイル
  4. 作ったソフトウェアのインストールマニュアル（インストールログ）
  5. 作ったソフトウェアの使用マニュアル＆テスト・デモ用データ
  • ドキュメントの詳細度に要求する事柄
    • 何も知らない学生が、ドキュメントに従って、まっさらなWindows, Mac OS, Linuxの状態から、実行環境、開発環境、ソフトウェアのインストール、そのソフトウェアのテスト・デモを行える状態まで行えなければならない。

大学の研究室の場合、2〜3年後にその研究を引き継ぐ学生が出てくる可能性があるので、実行環境の構築でつまづくことが多々ある。5年以上前の研究テーマの復活とかは非常に大変。

論文について

10年後でも読めることが重要。ゆえに、LaTeXが良い。

  • 論文のソースファイル（スタイルファイル、マクロファイル含む）
  • 論文中の図や写真のオリジナルファイル（編集ができるファイル）
  • 論文中の図や写真の論文掲載用ファイル（EPSファイルなど）
  • 論文中で言及している実験の生データ＆実験環境の構築マニュアル
  • （ソフトウェア系なら）実験に使用したソフトウェアのソースコード＆インストールマニュアル
  • 口頭発表時の発表資料（編集が可能な形のもの）
  • 論文のPDFファイル

参考資料について

電子ファイルならば、卒業・修了時に残してもらった方がありがたい。

  • 論文の電子ファイル（PDF）
  • 論文の書誌データ（BibTeX形式などで）