Document Types and Structure

This page explains the structure of the IFS Cloud Documentation, the different document types that are available, how the documents relate to each other, and also how the process models are integrated.

Read about:

IFS Cloud Documentation Structure

IFS Cloud Documentation is a process oriented documentation. The documentation focuses on activities, i.e., what you can perform and accomplish in IFS Cloud. Therefore, most of the available document types are connected to the process models in one way or the other. The activity descriptions can be reached from the related process models.

This is a simplified view of the structure of the IFS Cloud Documentation and how the documents relate to each other. From the IFS Cloud Documentation navigator, you also have direct access to the process models and the topic descriptions.

  1. IFS Cloud
  2. Use Page Help or IFS Cloud Documentation from the IFS Cloud menu
  3. If you using Page Help, a search result shows related documentation to current page
  4. Main Process Model (level 1), i.e., describes a main business processes with a sweeping overview of an entire business
  5. Process Description (answers: How should I interpret the model?)
  6. Process Model (level 2), i.e., details the main process.
  7. Topic Description, also called About Description (commonly answers: What goes into the process and what are the results?)
  8. Activity Diagram (level 3), describes the step-by-step procedure
  9. Activity Description (answers: How to do?)

Document Types

The following document types are available in the IFS Cloud Documentation:

Topic Description - Describes a work flow, a specific function, or functionality in the application. The topic descriptions (also called about descriptions) range from limited to extensive descriptions that most often describe the inputs and outputs of a certain process object. The topic descriptions can be reached from the related business objects in the process models, as well as by clicking Topics in IFS Cloud on the documentation navigator.

Activity Description - Describes how to perform a specific user action. The activity description answers: How to do? These activities are defined in the activity diagrams. The activity description contains a step-by-step procedure, an explanation of the activity and functionality, and detailed information on prerequisites and system effects.

Process Models - Illustrates a top-down approach, with business processes at the top level and details specific to IFS Cloud found at the lowest level. You can reach a variety of linked documents from the process models. Perhaps the most significant advantage of these models is the simplified understanding of the business processes offered by IFS Cloud. Like a geographic map, they offer both sweeping overviews and detailed models graphically illustrating the process flows at different levels of detail.

Process Description - Describes a business process/main process model in text format. Answers: How should I interpret the model? Provides information that cannot be illustrated in a model.