Document toolboxDocument toolbox

Microbizz (documentation)

These subpages describe all functionality in Microbizz and the pages are ordered exactly like the Microbizz name space, as this is how we developer thinks (wink)

As a note of exception all UI namespaces can be disregarded when creating new sections.

Documentation requirements

Datarecord objects - All datarecord objects must be documented with detailed description of each field in the object.

Settings - All settings must be documented, with detailed description to what the setting toggles and how it modifies system behaviour.

Flows - All work flows which are technical flows where the state of an object can change must be documented.

Algorithms - All algorithms must be documented, unless they are trivial.

UI Elements - UI elements must be documented if they are global (ie. can be used all over the system) or are intended to be subclassed by other components. The documentation must include how they are used, and which parameters and helper functions are available. For classes that can be extended, it should be noted how to extend them (which fields and functions to override). For global components, they should also be listed on the global components page.

Diagram

There is a huge system diagram on Nextcloud, the file \Product\Documents\Products – internal\Microbizz\Samlet systemoversigt.graphml

You'll need the free software yED to view it.