2011年08月12日

知識データベースプラグインが便利!on Redmine.

redmineでナレッジを蓄積していく方法:プログラマの思索

上記サイトで紹介されていました.


これ,今まで自分が使ってきたプラグインの中でも優れたユーザインターフェースをもつプラグインだと思う.

各項目に,複数のタグをつけて関連性を広げられたり,Article Ratingで5段階(実際は半分(0.5ずつ))評価できるのも面白いし,直感的で使いやすい.

knowledge_top.PNG

いきなり,感想を書いたけど,このredmineのプラグインを説明すると,knowledgebaseという名の通り,知識を集約することを目的としている.

・探しやすいように,カテゴリー分けすることができ,その下にそれぞれアーティクルが存在する.
・そのアーティクルに情報を記入していき,またファイルの添付も出来る.
・良いアーティクルには,高い★マークをつけて,他の人からも情報の役立ち度がレートを参照することでわかりやすくなっているし,
・第三者からの情報の補足として,コメントを付加することもできる.
・関連項目もさがせるように,複数のタグ付けを行うことが出来る.
・あと,アクセス権も割り当てられるらしいのだけど,これはよく分からない.


なんというか,自分の理解するイメージをそのままRedmine上に構築していける感じで,ページを追加していくのも楽しい.
Redmineでは,wikiは各プロジェクト単位に紐付けられているけど,一般的にどのプロジェクトにも属さないような情報をどう扱うか,自分はよく困っていて,あらゆるプロジェクトの親を作り,その親プロジェクトのWikiを全体共有用といて使用していた.


例えば,会社で運用しているのなら,その会社のシステム紹介や,運用ルール,コーディングルールなど,FAQに近いものがそういった情報に自分の場合は当たる.

プログラム言語で言えば,プログラミング全体におけるTIPSと,C言語,Java, Ruby,Haskellなど,それぞれの言語におけるちょっとしたコーディング方法なども分けて,メモしたり出来る.


この知識データベースプラグインの良い点の一つは,一番左上のトップに出るマイページなどと同じ所(ナビゲーションヘッダ)にアクセス先が用意されていて,いつでもアクセスできる点.全体的な情報を扱うなら,なおさら,いちいち親プロジェクトにアクセスしなくてすむのでクリック数が少なくて済むのはうれしい..

さらに,wiki からのリンクも貼れる.おぉー親切設計だ.


問題は,検索に引っかからないことだろうか.検索で,「チケット」,「ニュース」など,検索対象のところに「Article」という項目があるので検索に引っかかりそうなのだけど,自分の環境ではひっかかりません.何か不足しているのだろうか….


※検索で引っかかるようにするのは,ハックすることでできそうなので後日書きます.たぶん,来週.今日はもう疲れた!(2011/8/12)


・redmine_knowledgebase プラグイン

https://github.com/alexbevi/redmine_knowledgebase

上記からダウンロードできます.
このページをみながら使い方をざっと説明すると,こんな感じ.適当にしてるので誤訳あったらすみません.

■インストール

まず,以下のモジュールをダウンロードしていれます.これは,そのうちRedmineに取り込まれるとおもう.
(ただ,redmine-1.2.0ではなくても動くような気がします.)

・acts_as_viewed (http://rubyforge.org/projects/acts-as-viewed)
・acts_as_rated (http://rubyforge.org/projects/acts-as-rated)
・acts_as_taggable_on_steroids (http://github.com/jviney/acts_as_taggable_on_steroids)




プラグインを,ダウンロードして,redmine_root/vendor/plugins の下においてください.ディレクトリ名は "redmine_knowledgebase"です.
ダウンロード方法は,git から持ってきてもいいし,下記コマンドでもOKです.

% script/plugin install git://github.com/alexbevi/redmine_knowledgebase.git


データベースのバックアップ取ってから,migrate します.

% cd $redmine_root
% rake db:migrate_plugins RAILS_ENV=production


まぁ,ここにかいてあるのと一緒です.http://www.redmine.org/wiki/redmine/Plugins
で,redmine を再起動.



■使い方


管理→プラグインから,knowledgebase の設定をクリックして,必要に応じて数値を変更します.自分は変更していません.左上にある,knowledgebase をクリックします.

最初は,まだ何も無いはず.

■カテゴリー


右のほうにある,"+”マークの入った緑色の円アイコンをクリックすると,カテゴリーを作れます.
カテゴリーは,入れ子式にどんどん掘っていくことが出来ます.


動物 -+- 犬 -+-- ちわわ
   |   +-- ブルドッグ
   +- 猫




という感じで.さらに,各カテゴリーの下に,Articleがぶら下がります.


ルートカテゴリー(最上位のカテゴリー):

これが最初のカテゴリーになります.このカテゴリーにぶら下がるカテゴリーが,デフォルトとして右サイドバーに,カテゴリ一覧として表示されます.
これはあらゆるカテゴリーの親になります.

タイトル:
一覧で表示される件名です.

カテゴリの情報は,名前も,親カテゴリもあとで変更できます.カテゴリをつくると,ドロップダウンメニューから選択できるようになります.




■アーティクル


作り方は,カテゴリーと同じです.直感的に使えます.
どのカテゴリーに属するか選択して,タイトルを記述.また,短い文章で概要をかき,Contentに詳細を記述します.このセクションは,wikiフォーマットが使えます.

タグ:


コンマを挟むことで,複数のタグを設定できます.全体のタグ検索はまだ実装していませんが,開発中とのこと.タグ検索は,同じアーティクルレベル(同じ階層)内でのみ可能です.


ファイル:


ファイルを添付することが可能です.最大サイズは5MBです.(と書かれているけど,Redmineの設定で最大許容量を増やしていればできるのかも,試してないのでわかりません)


↓作成画面です.

knowledge_new.PNG

↓作成後

knowledge_sampleB.PNG



他には,参照しているアーティクルに対して,コメントを残すことが出来ます.
また,wiki やチケットからリンクをはることもできます.






■引用書式


・{{kb()}}


アーティクルの記事番号("KB#")を表示し,そこへリンクを張ります.例えば,{{kb(8)}}とすると,"KB#8"という文字列が表示され,これがアーティクルのNo.7にリンクされます.アーティクルナンバーはURLから自分は判断しています.

・{{article_id()}}

アーティクルの記事番号("KB#")を表示し,そこへリンクを張ります.例えば,{{article_id(7)}}とすると,"KB#7"という文字列が表示され,これがアーティクルのNo.7にリンクされます.上記と同じだと思います.


・{{article()}}

アーティクルの件名も表示し,そこにリンクを張ります.例えば,記事のNo.7が,"犬の育て方"という件名であれば,{{article(7)}}と書くことで,"KB#7: 犬の育て方"という文字列が表示され,この記事へのリンクが張られます.


・{{category()}}

カテゴリーの番号を入力することでカテゴリへのリンクが張られます.表示はカテゴリ名が表示されます.



kbってなんだろうと思ってたけど,KnowledgeBase のことだなと今頃気づいた...


参考に私の環境だとこう表示されます.まだ量が少ないので寂しいのですが.


knowledge_category.PNG


ラベル:plugin redmine ruby
posted by maplewine at 22:24| Comment(2) | TrackBack(0) | ruby | このブログの読者になる | 更新情報をチェックする
この記事へのコメント
まだ歯の軸が主導的な立場なので、皆至って入らないのが角を歯でかじる大きすぎます。だから、ウブロスーパーコピーが板と歯の軸のかみ合い歯末のたけに順番に当たって朕がすべて取るエピサイクロイドより低くて、しかし主変速機の中の歯の軸のようです低くそんなに多くありません。
Posted by パネライスーパーコピー at 2013年11月05日 17:33
スーパーコピーブランド時計、バッグ、財布代引き_[人気N級品]| Jpproshop777.com60年代と70年代に最もみごとなロレックスロレックスの腕時計は“ロレックスの航海するエリートの腕時計"今年のロレックスの航海するエリート時間単位の計算腕時計搭栽ロレックスロレックスが時間単位の計算のチップを自製して人に賛嘆させる技術機能を配備してそして初めてロレックスのシリーズのために運動の息を取り入れて’が新しい姿で再度新世代の航海するエリートの腕時計を発売する新しく人の面目を一新する感じに以前の設計の様子のスーパーコピーブランド
Posted by スーパーコピーブランド at 2014年01月04日 15:42
コメントを書く
お名前:

メールアドレス:

ホームページアドレス:

コメント:

認証コード: [必須入力]


※画像の中の文字を半角で入力してください。

この記事へのトラックバック
×

この広告は180日以上新しい記事の投稿がないブログに表示されております。