TUBAMEコミュニティへのナレッジ投稿方法

ユーザナレッジのフォーク

ユーザナレッジのクローン

ユーザナレッジのチェックアウト及びインポート

ブランチの作成

ナレッジ作成

コミット及びプッシュ、プルリクエスト

Eclipseより Git Repoistires View を開く

Window → Show View → Other → Git → Git Repositories

フォークしたuser-knowledgeリポジトリをクローンする

Git Repoistires View → Clone a Git Repositories

	Note
	URLにhttps://github.com/(あなたのgithubユーザ名)/user-knowledge.git を入力してください。 その後 Next → Master選択 → Next → Finish Finish後は、 Git Repoistires View にuser-knowledgeリポジトリが登録される。

user-knowledgeのチェックアウト

Git Repoistires View → user-knowledge → FETCH-HEAD → 右クリック → CheckOut

	Note
	Git Repoistires View の Working Directory に user-knowledge が展開されます

user-knowledgeをEclipseプロジェクトとしてインポート

Git Repoistires View → Working Directory → user-knowledge → 右クリック → Import Project

	Note
	Imports Project Wizard 起動後は以下を行ってください Imports Project Wizard → Wizard for projects → Import as general project → Next → Finsih

ブランチを作成する

Project Explorer → Team → Switch To → new Branch

	Note
	Wizard起動は、 Branch name にブランチ名を入力してください。 正常終了すると Git Repoistires View → user-knowledge → Branches → (作成したブランチ)にチェックマークが付与されます

ナレッジエントリビュー

個々のナレッジは ナレッジエントリービュー 上で追加・参照・更新・削除します。 作成したナレッジはアイテムとしてドキュメント作成等に活用できます。

Figure 1. ナレッジエントリビュー

ナレッジエディタ

ナレッジエディタは、以下の３つのタブより構成されている

ユーザナレッジ XMLファイル(UserKnowledge.xml)のオープン

Open With → Other → ナレッジエディタ

ナレッジエントリービューの操作

個々のナレッジは ナレッジエントリービュー 上で追加・参照・更新・削除します。 作成したナレッジはアイテムとしてドキュメント作成等に活用できます。 ナレッジエントリービュー は、以下のいずれかの方法で起動します。

ナレッジを構成するアイテム群の作成

アイテムの作成は以下の手順で実施します。最初はアイテムが 1 つもないため、必ず カテゴリ を作成することになります。

(アイテムの選択) → 右クリック → 任意の登録メニュー → 登録Wizard起動

	Note
	アイテムを未選択の場合は カテゴリ のみ作成可能です。

	Note
	上記の他に、コピー&ペーストによる作成も可能です。

ナレッジを構成するアイテムは、以下の種類があります。 以下に各アイテムの説明を記載します。

ナレッジエディタの操作

以下の「ナレッジを構成するアイテム群の作成」を参考に、ナレッジエディタを操作し、ナレッジを作成してください。

	Note
	TUBAMeコミュニティにあるユーザナレッジXMLファイル(UserKnowledge.xml)を操作する場合、サンプルとして「サンプルナレッジ」が登録されています。 ナレッジエントリビューにあるユーザナレッジのアイテムに対して、操作を行ってください。 Figure 1. TUBAMeコミュニティのユーザナレッジ

ナレッジ登録 (カテゴリアイテムの選択) → 右クリック → ナレッジ登録 → 登録Wizard起動

Figure 1. ナレッジ登録画面

	Note
	登録Wizard起動後は、ナレッジ名を登録してください

ナレッジコンテンツ編集 ナレッジ詳細

Figure 2. ナレッジ詳細タブ

	Note
	ナレッジ詳細タブより、DocBook形式でコンテンツを作成してください。 作成したコンテンツのプレビューはHTMLプレビューが可能です。 (ナレッジ詳細タブ内のエディタ領域) → 右クリック → HTMLプレビュー

	Warning
	コンテンツ素材について 画像ファイル figureタグのmediaobjectで画像ファイルを指定する場合は、プロジェクト直下から相対パスを指定してください。 テキストファイル figureタグのprogramlistingでテキストファイルを指定する場合は、ナレッジ管理(tubame.knowhow)プラグインのplugins/tubame.knowhow_*/resources/xslを起点とした相対パスを指定する。

チェックアイテムの作成 (ナレッジアイテムの選択) → 右クリック → チェックアイテム情報登録 → チェックアイテム情報登録Wizard起動

Figure 1. チェックアイテム情報登録

Figure 2. チェックアイテム情報登録Wizard画面

Note

チェックアイテム情報登録Wizardではチェックアイテム名のみで登録可能です。登録後はチェックアイテム情報をダブルクリックすることで チェックアイテム タブで編集可能です。 以下に チェックアイテム タブで編集する チェックアイテム情報 の各入力項目の説明をします。 Table 1. チェックアイテム情報 項目 説明 検索手順 登録するナレッジとしてどのような移植箇所をどのように検索するのかの概要を文章で入力します。 検索実施 ナレッジベース検索ツール で検索する際に、実際に検索対象とする場合はチェックを有効にします。 移植要因 移植が必要となる理由として該当する項目を選択します。 難易度 移植作業の難易度を選択します。 Note 選択基準は以下となります。 高 実装内容の大規模な修正が必要で、実装や設定等の大幅な見直しが必要 中 実装内容を考慮した小規模な修正が必要 低 実装内容を考慮せず軽微な修正で対応可能 不明 難易度不明 移植不可 移植不可 難易度詳細 移植作業の詳細な難易度を選択します。 Note 選択基準は以下となります。 高 難易度が 高 であるもの 中 難易度が 中 であるもの 低1 難易度が 低 であり、置換レベルで対応不可能であるもの 低2 難易度が 低 であり、置換レベルで対応可能であるもの 不明1 難易度が 不明 であり、JBossにて該当機能がなく難易度を判断できないもの 不明2 難易度が 不明 であり、JBossに該当機能があるかどうかも不明で難易度を判断できないもの 移植不可 難易度が 移植不可 であるもの 目視確認 設定したロジカルな検索条件だけでは移植項目が特定できない場合の目視による調査方法または、判定基準等を入力します。 ヒアリング確認 開発元に確認しなければ移植の必要性が判断できない項目の場合の開発元への確認内容を入力します。

検索対象ファイル

検索対象ファイルを指定する。

検索キーワード

パラメータは２つ存在します。キー1とキー2が指定できます。

検索モジュールファイル

XMLファイルでXPATH検索を行う場合のみ指定する。