アプリケーションのドキュメンテーションは、
ナレッジベースの中でも重要な部分の一つです。開発のドキュメントは、アプリケーションの要件から開発者間のノート、To-Do リストなどまで多岐にわたります。
GeneXus には、
Wiki スタイルのドキュメンテーションエディターおよびリポジトリがあります。
Wiki スタイルのドキュメンテーションは、世界中の IT コミュニティーで採用されています。ドキュメントは、
WYSIWYG (に近い) エディターで編集されます。
既定では、すべての
ナレッジベースに、ナレッジーベースに関する一般的および主要なドキュメントを説明する
メインドキュメントが含まれています。
メインドキュメントは、
KB エクスプローラーの [ ドキュメンテーション ] ノードの下にあります。
ドキュメンテーションや項目属性など、ほかのオブジェクトにリンクを含めることができます。
次の例を参照してください:
Attraction というトランザクションにリンクが追加されています。
リンクを含めるには、 [ 編集 ] エレメントで大括弧のペアを入力する必要があります。すると、選択可能なオプションがすべて表示されます。たとえば、「Transaction」を選択します。
KB 内で使用可能なトランザクションがすべて表示されます。
「Attraction」を選択し、そのトランザクションにリンクを追加します。
[ 編集 ] エレメントでは、次のようになります。
ここで、 [ プレビュー ] エレメントを選択します。
追加したリンクをクリックする場合:
Attraction トランザクションのドキュメンテーションに関連付けられた
Document オブジェクトが開きます (これは Attraction トランザクションの [ Documentation ] エレメントと同一です) 。
[ Transaction.Attraction を開く ] というリンクをクリックすると、ドキュメンテーションが開きます。
ナレッジベースのドキュメンテーションには、ファイルを格納することもできます。
上記の画像のように、ナレッジベースのドキュメンテーションに「Sales Department.doc」ファイルおよび「Administrative Department.doc」ファイルが追加されています。ファイルを追加する方法は、前述の説明と同様です。
GeneXus ナレッジベースに含まれるドキュメンテーションは、GeneXus を所有していないが Wiki スタイルの Web サイトにアクセスできるユーザーに便利です。たとえば、エンドユーザー、インストール後のソフトウェアカスタマイズを専門とするエンジニア、ナレッジベースを所有していないプログラマーなどです。
GeneXus では、ナレッジベースのドキュメンテーションを Wiki スタイルの Web サイトに容易に公開して、組織の内部および外部の人々がアクセスできるようにします。「
ドキュメンテーションの同期」を参照してください。
オブジェクトドキュメンテーション