読者です 読者をやめる 読者になる 読者になる

kengo700のナレッジベース

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

研究室のRedmineのナレッジベースについて

この記事では、私たちの研究室の研究ノウハウを蓄積するための、Redmineのナレッジベースページを紹介します。

はじめに

研究室に限らずあらゆる組織において、情報共有は重要だと思います。

プロジェクト管理システムRedmineを使うと、「チケット」機能により作業を「見える化」することができ、また「Wiki」機能によって情報をまとめて共有することができます(詳しくは下記記事参照)。

kengo700.hatenablog.com

さらにRedmineはプラグインにより機能を追加することができ、情報蓄積・共有のための「ナレッジベース」というプラグインが提供されています。

ナレッジベースプラグインの概要

ナレッジベースプラグインには、Redmineの標準機能の「Wiki」にはない機能として、下記のようなものがあります(ナレッジベースプラグインとWikiの比較については後の節でもう少し詳しく説明します)。

  • タグ・カテゴリ機能
  • 評価機能、評価値によるランキング
  • 閲覧者数カウント機能、閲覧者数によるランキング

このプラグインのインストール方法は、下記のページなどがわかりやすいと思います。

研究室のナレッジベース

私たちの研究室で運用しているRedmineのナレッジベースページを紹介します。

※使用しているプラグインなどのバージョンは下記の通りです。

ソフトウェア バージョン
Redmine 2.5.0
Knowledgebase 3.0.4
Redmine Wiki Extensions plugin 0.6.4

トップページ

ナレッジベースプラグインのトップページは下記のようになっています。

f:id:kengo700:20160411003743p:plain

ここには「要約」「最近更新された記事」「人気の記事」「評価の高い記事」と「カテゴリ一覧」が表示されます。

トップページに表示される記事の数は、管理者アカウントで「管理」->「プラグイン」->knowledgebaseの「設定」から変更することができます。

f:id:kengo700:20160411004707p:plain:w400

※この設定の「カテゴリをアルファベット順に並び替える」「ツリーのすべてのカテゴリを表示する」の設定は、変更しても変わらなかったのでよくわかりません。
※「記事要約の非表示」は、カテゴリ別の記事一覧ページの要約が非表示になります。

カテゴリ別の記事一覧ページ

各カテゴリのページには、カテゴリの説明、サブカテゴリおよびカテゴリ内の記事一覧(タイトルと要約)が表示されます。

f:id:kengo700:20160411005943p:plain

記事ページ

各記事は下記のようになっています。

f:id:kengo700:20160411010323p:plain

記事に表示される内容をタブによって切り替えることができます。タブは「詳細(記事の内容」「コメント」「ファイル(添付されているファイル)」「履歴(編集履歴)」があります。

※タブを切り替えないとコメントを見れないので、コメントに気づかなかったりします。通知が来るはずではありますが。

記事の編集やコメントなどは、右側のメニューから行うことができます。記事の編集ではWikiと同様の記法やWikiマクロを使うことができます。

その他

ナレッジベースプラグインはRedmineの検索機能と統合され、ナレッジベースの記事のみを絞り込んで検索することができます。

f:id:kengo700:20160411012124p:plain

Wikiとナレッジベースの比較

Redmineには情報蓄積・共有に使えるWiki機能があります。ここにナレッジベースを入れると使い分けが難しくなる可能性があり、私はナレッジベースプラグインの導入に割と悩みました。

試しに使ってみようと導入し、現在Wikiとナレッジベースの使い分けは下記のようになっています。

  • ナレッジベース → 色々な知識・ノウハウを集約する
  • Wiki → 研究室生活に関する重要な情報、更新頻度が高い情報をまとめる

しばらく使用してみた感想として、できればWikiのみを使う方がいいのではないかと思います(ナレッジベースプラグインを紹介しておいて何ですが(´・ω・`))。

機能の比較

Wikiとナレッジベースの機能と利点・欠点は下記のようになっています。ここでWikiには「Redmine Wiki Extensions plugin」を導入しています。

  • ナレッジベースプラグイン
    • 利点
      • タグ付けとカテゴリ分けができる
      • 評価や閲覧者数カウント機能がある
    • 欠点
      • トップページをカスタマイズできない
      • Redmineのバージョンアップに追従できない可能性がある
  • Wiki機能
    • 利点
      • 見出しごとに編集できる
      • 全ページを一括でPDF出力できる
      • カスタマイズしやすい
      • トップページがカスタマイズできる
      • Redmineの標準機能なので、バージョンアップ後も使える可能性が高い
    • 欠点
      • カテゴリ分けができない

RedmineのWikiでは、親子の関係を持つページを作成できます(いわゆる、パンくずリスト)。これを使うとカテゴリ分けを行うことができますが、親ページの設定の際にすべてのWikiページのリストから選ぶ必要があるので、Wikiページ数が数百になるとリストが長くなりすぎ選びにくくなります。このため親子関係でカテゴリ分けをすると整理が大変になります。

Wiki機能の「見出しごとに編集」とは、下記ページに説明されているようにh2 h3のような見出しごとに編集することができます。特にページの内容が多い場合(例えば以前の記事で紹介した用語集などの場合)に編集しやすくなります。ナレッジベースプラグインの記事では見出しごとの編集はできません。

Wikiのみを使う方がいいと思う理由

私がナレッジベース機能を使わずにWikiに統一した方がいいと思うのは、できるだけシンプルな方が使いやすいからです。

まず機能数が少ない方がRedmineを利用し始める際の学習コストが少なく使いやすいはずです。Redmineはユーザーインターフェースの評判があまりよくなく、使い方を覚えるのが少し大変なので、機能を増やすとそれだけ普及の障害になってしまいます。

またRedmineを管理するほうとしても、できるだけ機能が少ない方が労力が少ないはずです。

※利用するツールを使うメリットよりも、維持・管理コストが大きい場合は廃止するか、他のツールを使うべきですね。
※私たちの研究室ではRedmineなどを学生が管理しており、またサーバやWebサービスは専門外なので、保守やプラグインの修正を簡単に行うスキルがないという状況もあります。

逆にナレッジベース機能の一番のメリットは、カテゴリ分けがしやすいことです。しかし私はカテゴリ分けが苦手なので(このブログのカテゴリも適当)、カテゴリが多くなってしまい、逆に探しにくくなっています。

※個人的には、わざわざタグ付け・カテゴリ分けをしなくても、将来的には高度な検索機能で欲しい情報を見つけることができるようになるのではないかと思っています。

関連記事

kengo700.hatenablog.com

おわりに

Wikiやナレッジベースプラグインのメリット・デメリットは、Redmineのプラグインを弄ることができるスキルがあれば改善できるので、そのような方は好みで選んでください。