Table of contents

Official Content

Application documentation is an important part of your Knowledge Base. Development documents range from application requirements to developer-to-developer notes, to-do lists, etc.

GeneXus provides a Wiki-style Documentation editor and repository. Wiki-style documentation has been adopted and is used by the IT community worldwide. Documents are edited with an (almost) WYSIWYG editor.

By default, each Knowledge Base contains a Main document to describe there the general and main documentation about the KB. You can find the Main document in the KB Explorer under the "Documentation" node.

You can include links to other objects' documentation, attributes, etc.

In the following example:

Document object with transaction link V17

A link to the Transaction called Attraction has been added.

To include a link, you have to type a pair of square brackets in the Edit section. That will display all the possibilities to select the one you need. For example, select "Transaction":

Rectangular brackets documentation v17

All the Transactions available in your KB will be displayed:

Links of Transaction to add to a document object v17

Select Attraction to add a link to that Transaction.

In the Edit Tab, you will see it as follows:

Attraction trn as link in document object V17

Now, select the Browse Tab.

If you click on the link you have just included:

Attraction trn as link in document object V17 - Browse tab

The Document object associated with the Attraction Transaction Documentation will be opened (it is equivalent to the Attraction Transaction Documentation tab).

Document object with transaction attraction V17

If you click on the link titled "Open Transaction.Attraction" it will be opened.

Files can also be stored in the Documentation of your Knowledge Base.

Document object with links V17

As you can see in the image above, the files "Sales Department.doc" and "Administrative Department.doc" have been added to the Knowledge Base Documentation. The way to add them is the same as the one explained before.

Documentation included in a GeneXus Knowledge Base may be useful for people who do not have GeneXus but have access to a Wiki-style website. End users, people who specialize in customizing software after installation, and programmers who do not have the Knowledge Base at hand are just a few examples of the people who may find it useful.

GeneXus lets you easily publish your KB documentation on a Wiki-style website, making it accessible to everyone inside and outside your organization. See Synchronize Documentation.

See Also

Object Documentation

Subcribe to this category's changes
Sub CategoriesAdd a new subcategory in this category
PagesAdd a new page in this category
Last update: November 2023 | © GeneXus. All rights reserved. GeneXus Powered by Globant