These guidelines for compiling, supplementing and maintaining DOKA-NG documentation make it possible for the documentation to be updated by both support staff and users and ensure that content does not get lost when updating.

A distinction is made between user documentation, documentation for the MyModelbank, developer documentation and TradeDesign documentation.

The purpose of these guidelines is to

• ensure a uniform visual presentation of the documentation
• enable its use as online help
• allow the documentation to be supplemented in the customer environment - only possible with delivery

The documentation is generally written in US English and translated into German once it has been reviewed in terms of content and language.
The same does not apply to the technical documentation (TradeDesign), which only exists in English. For developer documentation translation can be waived, then in the German version the link is set directly to the English page.

The documentation is stored in the “dokuwiki” subdirectory of DOKA's installation directory. This directory does not normally form a part of the product as supplied; the current version is available online.

Due to the specific structure of Dokuwiki, the individual 'pages' of the documentation are stored in the 'data\pages' subdirectory and its dependent subdirectories. As is the case with the user documentation, next there is one subdirectory each for the languages 'de' and 'en'. Below these one directory corresponding to one book

• 'app' for user or application documentation, aimed at end users and system administrators (in terms of content)
• 'dem' for the MyModelbank documentation, aimed at end users and system administrators
• 'dev' for the developer documentation.

What other subdirectories exist depends on how the content is structured. As Dokuwiki directories and pages are listed alphabetically, all directory names start with a 3-digit number, and all filenames (=pages) with a 4-digit number (exception: the 'Start' pages in each of the directories).

Images (.gif, .jpg, .png) are stored in the directory called 'media\images'. The remainder of the structure is according to language 'de' and 'en' and the subject 'app', 'dev' and 'dem'.

The directory structure and the filenames in 'de' and 'en' must be identical.

The filenames of pages containing automatically generated information must conform to the notation of the relevant document type. This is described in detail under the transaction Generating Documentation (Wiki format).

For files that do not contain automatically generated text, the filenames can be chosen freely ; filenames that overlap with those of generated files are not permitted, however.

For each

• transaction
• external codetable
• database table
• messagetype with defined mapping
• party model

in DOKA, one document is generated automatically. This document contains the current status of the transaction at the time the documentation was generated. The documentation generator reads the sources and uses descriptions, panels, datafields and helptexts applying to and/or used in the relevant transaction, codetable or database table and uses them to generate the documentation. Image files generated for the individual documents are stored in an appropriately assigned 'images' directory.

Automatically generated documentation can and should allow texts to be inserted manually. In doing so, care must be taken to insert additional text between a "/* id="TD_End_" comment and a "/* id="TD_Start", to ensure that the added information will be preserved when the documentation is re-generated.

Links to other wiki pages should only be used sparingly, and, wherever possible, only within the same book. If possible, avoid linking to other books in the documentation.

In the directory and page names special abbreviations are used, which lead to the function of this page:

• Field names, also such of check- and comboboxes, panel names and transaction descriptions will be written “italic” in text.
  Values for the content of a field in quotation marks.
  
  Example: 'Irrevocable' in field “Form of L/C” .
  Please note: for German use double quotes “, for English single quotes '.

• Buttons will be shown in square brackets.
  
  Example: Button [Save]

• For icons the picture in size 20 will be included in the text, that means, a link to the respective image will be used.
  
  Example: Icon , written 'Icon {{images:but:but_sav.png?20}}'