2014年4月11日金曜日

Alfrescoのアドオン Manual Manager でマニュアルを作成する

こんにちは。
株式会社Pro-SPIREソリューション事業部の藤野です。

以前、当ブログでECMツールのAlfrescoについてご紹介させていただきました。

オープンソースのECMツール Alfresco
http://developers.pro-spire.co.jp/2014/04/ecm-alfresco.html
※上記のリンクは外部サイトが別ウィンドウで開きます。

Alfrescoはアドオンを追加することにより、多彩な機能を付け加えることができます。
今回はそのアドオンの中の1つ、Manual Managerを導入するまでの流れを追ってみたいと思います。

Manual Managerについて

プロジェクトが進むにつれ、開始当初よりチームメンバーが増えたり減ったりすることがあります。

新規メンバーがスムーズに業務をこなせるようにマニュアル(手順書)を用意しますが、
ありがちな MS Word ファイルなどで作るのは編集に手間がかかってしまいがちではないでしょうか。

決定事項や開発手順は変更されることが多いですし、かといってそれを記録しておかないと、
後になって「あれって結局どうすることになったんだっけ?」なんてことになってしまいます。

そんなときにAlfrescoにManual Managerのアドオンを追加すれば、
Markdown形式でかんたんにマニュアルを作成し、保管することができます。

Markdownとは、軽量マークアップ言語のひとつで、シンプルなテキスト文章をHTMLに変換してくれる書式のことです。
HTMLのような書式つき文書を手軽に書きたいときに利用すると便利です。

マークダウンとは
http://kojika17.com/2013/01/starting-markdown.html
※上記のリンクは外部サイトが別ウィンドウで開きます。


作成したマニュアルはAlfrescoのリポジトリに保存されるため、Alfrescoのアカウント登録さえ済んでいれば、Webブラウザーで直接閲覧することができます。

新規メンバーが開発プロジェクトに参画したとき、Officeソフトも入っていない標準の状態のPCでも、最初にマニュアルに目を通すことができるということです。

Manual Managerを導入することで作業効率がアップし、知識共有が円滑になることが見込まれます。

Manual Managerをインストールする

それではManual Managerを導入してみましょう。

まずは次のサイトでAlfrescoのアドオンを検索します。

Alfresco Add-ons
※上記のリンクは外部サイトが別ウィンドウで開きます。

「Search for add-ons」をクリック

テキストボックスに「Manual」と入力し、「Manual Manager」をクリック。

「Downloads」をクリック。


するとソースコードを共有できるサイトGitHubのページに飛びます。
こちらからダウンロードするようです。英語なのが辛いです。


下の方にスクロールしていくと「README」があり、さらに下にはインストール方法が書かれています。


手順としては以下のとおりです。
  1. クローンリポジトリーを作成する。
  2. 「ant」コマンドでコンパイルし、jarファイルを生成させる。
  3. そのjarファイルをAlfrescoの所定のディレクトリにコピーする。
  4. Alfrescoを再起動する。

それではやってみます。

1.クローンリポジトリーを作成する。

Manual Managerのクローンを作成します。
例として、Alfrescoがインストールされているサーバーにリモートログインして、そこで作業を行ないます。
ちなみに私は、サーバーへのリモートログインにはPoderosaを使ったSSH接続を利用しています。
※上記のリンクは外部サイトが別ウィンドウで開きます。

$ git clone git://github.com/loftuxab/manual-manager.git ManualManager


できたてのManual Managerの階層に移動します。
$ cd ManualManager
ここでAlfrescoのバージョンが4.0.xの場合は次のコマンドを実行し 4.0ブランチをチェックアウトしてください。
$ git checkout 4.0

2.「ant」コマンドでコンパイルし、jarファイルを生成させる

次に、Antコマンドでコンパイルしますします。
最初からAntがあれば良いのですが、今回の環境にはAntが無かったのでインストールするところからやります。

ここではソフトウェアをインストールするyumコマンドを使います。

rootユーザーに変わり、CentOSのリポジトリーにAntがあるか確認します。
# yum search ant
ありました。

Antをインストールします。
# yum install ant

これでantコマンドが実行できるようになりました。
Manual Managerの階層にいることを再度確認し、Antを実行します。
$ ant package 

jarファイルが生成されたことがわかります。


3.そのjarファイルをAlfrescoの所定のディレクトリにコピーする

次の2つのディレクトリにコピーします。

[Alfrescoのルートディレクトリー]/tomcat/webapps/alfresco/WEB-INF/lib
[Alfrescoのルートディレクトリー]/tomcat/webapps/share/WEB-INF/lib

今回のAlfrescoは、既存のTomcatなどにデプロイしないスタンドアロン構成で、
/opt/Alfresco-4.2.c にインストールしている状態です。
$ cp /home/fujino/ManualManager/build/dist/loftux-manual-manager.jar /opt/alfresco-4.2.c/tomcat/webapps/alfresco/WEB-INF/lib 
$ cp /home/fujino/ManualManager/build/dist/loftux-manual-manager.jar /opt/alfresco-4.2.c/tomcat/webapps/share/WEB-INF/lib

4.Alfrescoを再起動する

あとはAlfrescoを再起動するだけです。
$ service alfresco restart
以上で完了です。
起動後、Alfrescoのダッシュボードを確認してみましょう。

「サイトのカスタマイズ」で、「利用可能なサイトページ」に「Manual」が追加されているのが確認できます。

アイコンをドラッグアンドドロップしてOKを押します。

ダッシュボードにManualが追加されました!



Manual Managerを使ってみる

ダッシュボードで「Manual」タブをクリックし、「Create new topic」を選択。


題名を入力します。同様の作業で階層を作ることもできます。
「Edit」で編集します。



編集画面では右側にプレビューが表示され、リアルタイムで確認ができます。


Markdownは「*」や「-」など記号1文字で表示形式の定義ができるのでHTMLを書くよりもずっと簡単です。

例)
#見出し
通常文字

改行するには空白行を入れます。

**太字**

>引用

>引用

#見出し
* リスト
* 「*」+スペース
1. リスト
2. 数字+「.」+スペース


結果がこちら↓↓↓



さらに具体的なMarkdownの書き方についてはこちらで詳しく紹介されています。ご参照ください。

マークダウンとは
http://kojika17.com/2013/01/starting-markdown.html
※上記のリンクは外部サイトが別ウィンドウで開きます。

まとめ

少し時間がかかりましたが、新人の私でもなんとかインストールはできました。
Markdownの書き方さえ覚えてしまえば、視覚的にわかりやすい書式つきのドキュメントを簡単に作成することができます。

画像もクリックひとつで挿入できるので手順書作成には最適なツールだと思います。

ぜひ試してみてはいかがでしょうか。

0 件のコメント:

コメントを投稿