Document Principles
The documentation guidelines are based on Microsoft´s default.
General Formatting Rules
Essentially, the following formatting rules apply:
| Type | Description |
|---|---|
| Objects | If objects are referenced in the text, they must be marked as bold. Examples of object types are: tables, forms, reports, etc. |
| Buttons | Buttons (buttons) are highlighted in bold. |
| Fields | Field names should be highlighted in bold. |
| MENU path | Menu paths are marked in CAPITAL LETTERS. Successive connected menu paths must be connected with a >. |
| Keyboard combinations | Keyboard combinations are marked in bold. Multiple affected keys are connected with a +. |
Definition of Object Types and their Application
The following types of objects should be used:
| Type | Description |
|---|---|
| Table | Defines the underlying data structure. Also defines and triggers check routines that are used when entering data. |
| Page | The windows and menus are visible to the user. |
| Report | Use for reports and batch jobs. |
| Dataport | Use for importing and exporting data. |
| Codeunit | Use for storing program routines. |
| XMLport | Use for importing and exporting data. |
The following types of forms can be used:
| Type | Description |
|---|---|
| List | A table-shaped window like an excel table. Can display multiple records at the same time. |
| Page | A window in card shape. Displays 1 record per card. |
| Matrix | Window with a combination of list and map style that combines data from multiple tables, such as dimensional analysis. |
The Form usage includes:
| Type | Description |
|---|---|
| Info register / FastTab | Use to organize the fields on a page. |
| Field | Use to enter or display data. |
| Look-up | Opens a new window with a list of data values to choose from. |
| Drill-down | Opens a new window with detailed entries. |