Show TOC

Function documentationBasic Concepts

 

In this chapter, you can familiarize yourself with the basic concepts of Solution Documentation.

Libraries
  • Process Step Library

    The process step library is a business oriented collection of re-usable process step originals used to assemble processes. It is grouped by functional domains that correspond to organizational structures (for example financial, production or sales). All process step originals should exist only once to obtain an overlap-free library structure.

  • Executable Library

    The executable library is a functional oriented collection of re-usable executable originals used to facilitate process step originals with execution means. It is calculated using managed system usage data (performance database and usage and procedure logging). All executable originals are automatically grouped by logical component groups on the first level and on the following using the application software structure (application component hierarchy or development package).

  • Development Library

    The development library is a functional oriented collection of re-usable development object originals to document executable customer enhancements. It is calculated using managed system usage data (performance database and usage and procedure logging). The development object originals are automatically grouped by logical component groups on the first level and on the following using the applications software structure (application component hierarchy or development package).

  • Interface Library

    The interface library is a functional oriented collection of re-usable interface originals used to depict how system breaks are bridged. It is organized according to scenario and functional aspects and follows operational needs.

  • Configuration Library

    The configuration library is a functional oriented collection of re-usable configuration units used to describe the configuration of single functions, complete applications, or processes. It is grouped by functional domains that correspond to organizational structures (for example financial, production or sales) and organized according to a process organization.

Lifecycle based on Branches

A branch represents a version of the Solution Documentation containing processes, libraries, and systems.

  • The production branch represents the productive version of the entire Solution Documentation.

  • The maintenance branch represents the editable version of the productive Solution Documentation. It provides an safe environment for performing changes.

  • The development branch represents the development version for future Solution Documentation.

There is always a production and a maintenance branch but customers can define as many additional branches as required. A child branch, like a maintenance branch, has always full visibility into the Solution Documentation of the parent, for example in the maintenance branch, all unchanged elements have the state of the production branch.

The branch setup should be driven by the customers system tracks and the planned customer releases.