kengo700のナレッジベース

誰かの役に立つと思う情報を発信するブログ

研究室のRedmineの概要

私たちの研究室では、各種作業や物品の記録・管理および情報共有のために、プロジェクト管理システム(RT-redmineと名付けています)を運用しています。これには、オープンソースのRedmineを利用しています。

この記事では、研究室のRedmineの概要を説明します。

はじめに

もしRedmineについてあまり知らない場合は、先に下記記事を読むことをお勧めします。

kengo700.hatenablog.com

kengo700.hatenablog.com

研究室のRedmineのホーム画面

研究室のRedmineのホーム画面は下図のようになっています。ホーム画面には、よく使う(と私が思った)ページへのリンクを貼っています。

f:id:kengo700:20160107020011j:plain

主なページの概要

研究室のRedmineの用途を紹介するために、ホーム画面にリンクが張ってあるページの概要を説明します。各ページの詳細は別の記事に書く予定です。

※この節は長いので、次の見出し「導入の経緯」まで読み飛ばす場合はここをクリックしてください。

リンク1

f:id:kengo700:20160108062827j:plain

ホーム画面上部に、頻繁にアクセスするページへのリンクを張っています。

  • 臨時リンク
    • その時期によくアクセスするページへのリンクを貼っています。私たちの研究室では年度末に大掃除を行い、その情報を1つのプロジェクト*1にまとめているので、現在はそのプロジェクトへのリンクを表示しています。
  • 初めての方へ / Beginner
    • 研究室のRedmineに初めてログインした人用のWikiページへのリンクです。
  • 新着 / What's New
    • Redmineの更新情報ページ*2へのリンクです。  
  • 検索 / Search
    • Redmineの全体検索ページ*3へのリンクです。  
  • 掲示板 / Forum
    • フォーラム(Redmineの掲示板機能)へのリンクです。

データベース / Data Base

f:id:kengo700:20160108063207j:plain

研究の知識やノウハウを蓄積・共有するためのプロジェクトです。

  • ナレッジベース / Knowledge
    • 研究の知識やノウハウを蓄積するページです。「knowledgebase」というプラグインを利用しています。
  • ウィキページ / Wiki
    • 研究室に関する重要な情報、更新頻度が高い情報を蓄積するためのWikiページです。
  • 研究室に新しく人が来たとき
    • 研究室に新しくメンバーが配属されたときに必要な作業についてまとめたWikiページです。
  • 用語集 / Glossary
  • フォトギャラリー / Photo Gallery
    • 研究室のイベントなどで撮った写真をまとめたWikiページです。
  • 研究室案内図 / Floor Map
    • 研究室の案内図のWikiページです。
  • 学位論文リスト / Theses List
  • 学会 / Conference
    • 学会の予定などをまとめたページです。

イベント / Events

f:id:kengo700:20160108063226j:plain

研究室関連のイベントをチケット*4にまとめて記録・周知するためのプロジェクトです。詳しくは:Redmineのチケットで研究室のイベントを周知・記録(Googleカレンダーへ読み込む) - kengo700のブログ

  • イベント一覧 / Event list
    • イベントのチケットの一覧ページです。
  • カレンダー / Calendar
    • イベントのチケットをカレンダーに表示したページです。
  • ガントチャート / Gantt Chart
    • イベントのチケットをガントチャート*5に表示したページです。
  • 研究会 / Lab. Seminar
    • 研究室の進捗報告会のチケットの一覧ページです。
  • 学会の予定 / Conference
    • 学会(学術会議、カンファレンス)のチケットの一覧ページです。
  • 全体ミーティング / Meeting
    • 研究室の学生が各種案件について話し合うミーティングのチケットの一覧ページです。

装置・設備 / Equipment

f:id:kengo700:20160108063234j:plain

研究室の各種装置・設備をチケットにまとめて管理するプロジェクトです。

  • 装置・設備一覧 / Equipment List
    • 全ての装置・設備のチケットの一覧ページです。
  • 購入リスト / Shopping List
  • 実験スペース / Free Lab. Space
    • 研究室の実験を行う場所の予約をチケットで行うプロジェクトです。
  • 共有PC / Shared PC
  • 工作機械 / Machine tool計測機器 / Measuring Equip.撮影機器 / Filming Equip.
    • 研究室にある工作機械、計測機器、ビデオカメラなどをチケットで管理するプロジェクトです。
  • 工作機械使用記録
    • 研究室にある工作機械の使用者などをチケットで記録するプロジェクトです。
  • オフィス機器 / Office Equip.
  • ソフトウェア / Software license.
    • 研究室で使えるソフトのライセンスをチケットで管理するプロジェクトです。
  • その他の設備 / Other Equip.
    • 前述のプロジェクトに含まれない装置・設備をチケットで管理するプロジェクトです。

※このあたりはプロジェクトを細かく分けすぎているので、そのうち整理統合したいと考えています。

研究 / Research

f:id:kengo700:20160108063246j:plain

各研究テーマごとにサブプロジェクトを作り、チケットやWikiで研究内容を記録するためのプロジェクトです。

雑務 / Routine Tasks

f:id:kengo700:20160108063254j:plain

研究室での雑務を、担当ごとにサブプロジェクトを作り、チケットやWikiで作業内容を記録するためのプロジェクトです。詳しくは:Redmineのチケットで研究室の雑務管理 - kengo700のブログ

  • 業務一覧 / Role List
    • 研究室の雑務の概要をチケットに書き、一覧で見れるようにしたページです。
  • 自分の業務 / Your Role
    • 研究室の雑務のうち、自分が担当になっているもののチケットを一覧で表示するページです。
  • Web管理
    • 研究室のホームページやRedmineなどの管理者用のプロジェクトです。
  • ファイルサーバ管理
    • 研究室のファイルサーバの管理者用のプロジェクトです。
  • メール管理
    • 研究室メンバー用のメールアカウントの管理者用のプロジェクトです。
  • 内部ネットワーク管理
    • 研究室のネットワークの管理者用のプロジェクトです。
  • ライセンス管理
    • 研究室で購入したソフトのライセンスの管理者用のプロジェクトです。
  • その他の作業
    • 担当者がいない作業を記録するためのプロジェクトです。

個人ページ / Personal Page

f:id:kengo700:20160108063301j:plain

Redmineの使い方に慣れるために、研究室メンバーが自分用のサブプロジェクトを作り、自由に使えるようにしているプロジェクトです。

  • ニコニコカレンダー一覧
    • Redmineに「Niko-niko Calendar2」というプラグインをいれてニコニコカレンダーを使えるようにしています。そのニコニコカレンダーの全員の一覧ページへのリンクです。

ニコニコカレンダーについては、下記ページなどを参照してください。

リンク2

f:id:kengo700:20160108063307j:plain

ホーム画面下部に研究室の他のWebサービスへのリンクを貼っています。

  • Lab. Website
    • 研究室のホームページへのリンクです。
  • RT-slack
  • RT-gitlab
    • 研究室のバージョン管理システム(RT-gitlabとよんでいます)へのリンクです。GitLabというオープンソースソフトウェアを利用しています。

他に、大学が提供しているWebサービスへのリンクも貼っています。

導入の経緯

※一つ前の見出し「主なページの概要」まで戻るにはここをクリックしてください。

研究室のRedmineは、2014年8月にテスト運用を開始しました。

それ以前の研究室には、10年ほど前に先輩が立ち上げたRT-wiki*6とよばれるWikiシステムがありました。このWikiは、立ち上げた先輩が卒業した後はあまり使われていませんでした。しかし数年前に助教の先生と先輩方が研究室の情報共有を活発にするためにいろいろとページを整備しはじめ、私もいくつもページを追加しました。

このWikiは、特に表などが編集しにくかったので、もっと便利な物はないかと探したところRedmineを見つけました。Redmineのチケット機能を使えば、ソートや絞り込みのできる表を実現できそうだったため、Redmineをちょうど空いていたパソコンにインストールしてみました。

また数年前に、研究室のインターネットのトラブルに対応するため、担当の学生が一時研究ができなくなる状態になりました。そこでミーティングにおいて、研究室の雑務を担当する学生の負担を減らしたい、ということが話し合われました。負担を減らすためにチケット機能が利用できるのではないかと考えたことも、Redmineの運用を開始した理由の一つです。

※ちなみに、旧WikiからRedmineへは、私が一ページずつ手動で移行しました。データベースからページデータを取り出し変換して取り込むようなスキルはありませんでした。

利用状況と課題

残念ながらあまり活発には利用されていません。 現役生のアカウントのうち、直近一週間でアクセスしたアカウントは50%です。

特に、Redmineのチケット機能を使いこなしているメンバーはあまりいません。ただし、共有パソコンの管理チケットや買い物リスト用のチケットなどは更新されています。作業や研究の記録および役割分担にチケットを使う学生がほとんどいません。私も研究をチケットで管理(チケット駆動研究!)しようとして挫折しました(ものぐさな人間なので。研究を始めたときからRedmineがあれば続いたかもしれませんが)。

前述のナレッジベースページやWikiページは、活用している人は活用しているみたいです。一番アクセスされているWikiページは前述の「学位論文リスト / Theses List」ページで、現在累計457アクセスです(しかし2年間以上の累積数が、このブログの記事に1日で抜かれたんですがそれは・・・)。

これまでに下記のような布教活動をしましたが、あまり成果は上がっていません。

  • 前述の個人ページを用意し、自由に試せるようにした
  • Redmine内に使い方の解説ページを揃えた
  • Redmineの使い方を、実際に使いながら教える勉強会を開催した
  • 勉強会の様子を撮影して共有した

あまり活用されない理由の一つは、(私以外の)メンバーが優秀すぎるため、情報共有や過去の記録が適当でも、雑務をこなしつつ研究成果をあげられるからではないかと思います。Redmine導入以前も、力技で何とかなってしまっていました。個人的には、大学の研究室はメンバーの入れ替わりが比較的早く、知識量も多種多様なので、情報の共有・記録がとても大切だと思うのですが。

また現状の課題として、Redmine導入時に私が張り切って機能を追加しすぎたため、使い方を覚えるのが大変になっています。全く使われていない機能もあるので、時間があれば下記のような改善を行いたいと考えています。

  • 機能を減らす
    • 掲示板を廃止してSlackに統合するなど
  • プロジェクト数を減らす
    • 大掃除用のページなどは毎年、別のサブプロジェクトを作っていますが、一つのプロジェクトにまとめるべきでした。
  • カスタムフィールド*7、トラッカー*8の種類を減らす
  • プラグインを減らす
  • メール通知を切る
    • Slackへの通知のみにする

詳しくは別の記事に書くかもしれません。

その他

Redmineのバージョンなど

Redmineバージョンなどは下記の通りです。

  • Redmine:Redmine 2.5
  • OS:CentOS 6.5
  • データベース:MySQL 5.1.73
  • webサーバ:Apache 2.2.15
  • Ruby:2.0.0

基本的に下記ページの通りにインストールしました。

Redmineのテーマは、下記ページの物を利用しています。

使っているプラグイン

研究室のRedmineには下記のプラグインをインストールしています。

  • Clipboard image paste 1.8
    • コピーしたりスクリーンショットを取った図を簡単にWikiなどに張り付けることができる機能を追加する
  • Latest Issues plugin 0.0.1
    • ホーム画面に最新のチケットを表示する
  • Redmine Absolute Dates plugin 0.0.2
    • チケットの作成日などの「XX日前」の表示を「yyyy/MM/dd」に変更する
  • Blocks Layout plugin 0.0.2
    • ホーム画面のレイアウトを変更可能にする
  • Redmine Embedded Video 0.0.3.1
    • Wikiなどに動画を張り付けやすくする
  • Redmine Extended Reminder plugin 0.0.1
    • リマインダメールの設定を変更する
  • Issue Importer 1.2.2
    • データファイルを読込んでチケットを登録する機能を追加する
  • Redmine jsToolbar Extension 0.2.0
  • Redmine jsToolbar Buttons Extension 0.2.0
  • Redmine jsToolbar Coderay Extension 0.1.0
    • Wiki等の編集画面のツールバーを変更する
  • Knowledgebase 3.0.4
    • ナレッジベース機能を追加する
  • Redmine Login Audit plugin 0.1.5
    • ログイン日時などを確認できる機能を追加する
  • Redmine Niko-niko Calendar2 plugin 0.1.0
    • ニコニコカレンダーを追加する(詳細は前述の通り)
  • Redmine Oauth Provider plugin 0.0.2
    • RedmineのアカウントでGitLabにアクセスできるようにOauthという機能を追加する
  • Redmine People plugin 0.1.8
    • ユーザー機能を拡張する
  • Redmine Q&A plugin 0.0.5
    • フォーラム機能を改善する
  • Redmine Slack 0.1
    • チケットの更新情報をSlackへ投稿する
  • Redmine Tn3gallery plugin 0.0.1
    • Wikiにギャラリーを表示する機能を追加する(このプラグインは自作で、公開もしていません)
  • Watcher Groups plugin 0.0.3git
    • チケットのウォッチャー*9にグループ*10を設定できる機能を追加する
  • Redmine Wiki Extensions plugin 0.6.4
    • Wikiに様々な機能を追加する
  • Issues XLS export 0.2.1.t7
    • チケットをエクスポートすることができるようになる
  • Sidebar Hide Plugin 0.0.7
    • サイドバーを非表示にすることができるようになる
  • Simple Author Change plugin 0.0.1
    • チケットの作成者を変えることができるようになる
  • View Customize plugin 1.1.0
    • Redmineの表示をカスタマイズしやすくなる

※プラグインを入れすぎました。また他にも、インストールしたものの使わず、しかしアンインストールが面倒くさいのでそのままにしているプラグインが幾つかあります。アップデート作業が大変になるので、プラグインはあまり入れない方が良いですね。

留学生への対応

私たちの研究室は留学生が比較的多いので、トップページのリンクは英語を併記しています。各ページなども重要なところは英文を併記するようにしていますが、日本語だけのページも多いです。

※英語と日本語が堪能な学生もいますが、給料も出ないのに翻訳を頼むのは憚られます。研究に集中して欲しいですし。

なお、Redmineは多言語対応していますので、個人設定を変えればメニューなどは他の言語で表示されます。

ホーム画面のソースの一部

ホーム画面にリンクを並べるために、下記のように表内にリンクを書き込んでいます(試していませんが、他のテーマだと表の枠が表示されてしまうかもしれません)。

|{width: 200px}.<a href="「ページのURL」">「リンクの文字」</a> |{width: 200px}.<a href="「ページのURL」">「リンクの文字」</a> |{width: 200px}.<a href="「ページのURL」">「リンクの文字」</a>|

ただし、Redmineの設定でaタグを有効にしておく必要があります。有効にする方法は下記ページを参照してください。

ホーム画面の文字を変更するには、下記ページの「ウェルカムメッセージ」を編集します。

※余談ですが、サーバなどの設定を解説して下さっているホームページに"PASSWORD"<USERNAME>などのように書いてあると、この" "< >を含めて書くべきなのかどうか迷います。

リンク

kengo700.hatenablog.com

おわりに

「RT」はロボットテクノロジー (Robot Technology) の略です。たぶん。

*1:Redmineの機能のひとまとまりのこと。

*2:ページのURLは、<RedmineのトップページのURL>/activity

*3:ページのURLは、<RedmineのトップページのURL>/search

*4:Redmineの主要機能で、作業内容や担当者などをまとめた「付せん」のようなものです。

*5:日付がついた表のことです。

*6:Hiki(http://hikiwiki.org/ja/)というソフトを利用していました。

*7:Redmineのチケットの項目を自分で追加したものです。

*8:Redmineのチケットの種類の設定のことです。

*9:設定した人も通知が届く機能です。

*10:Redmineのユーザを分類する機能です。