Documenting Your Solutions Efficiently

Objective

After completing this lesson, you will be able to document your solutions efficiently in SAP Cloud ALM

Documentation in SAP Cloud ALM

The figure explains the possibilities of SAP Cloud ALM to act as the central source of truth for the documentation of the solution.

With this documentation object, SAP Cloud ALM can be a central source of truth of all your solution documentation.

It is connected to other elements such as processes, tasks, requirements, and more.

Choose the Documents tile to start adding documentation.

Choose the Documents tile to start adding documentation.

In the Documents app, you can create or edit documents in the context of a project.

Example of a document.

A document consists of:

  • Content: definition of the document.
  • A title and document text.
Components of a document.

A document consists of extra information:

  • Document Type
  • Document Status
  • Owner
  • Priority
  • Admin data like ID, "created by/on"
Further additional information of a document.

Further additional information:

  • Status:
    • In progress (Default)
    • In Review
    • Released
  • Priority:
    • Low
    • Medium (Default)
    • High
    • Very High
  • Owner (Default = Creator)
Further additional information of a document: Document Types.

Predelivered Document Types can be used to categorize documents by their purpose:

  • Business Process Document
  • Solution Design Document
  • Functional Specification
  • Technical Design Document
  • Configuration Guide
  • Interface Specification
  • End user Documentation
  • Project Documentation
  • Test Document
Assign Solution Process within Documents.

Documents can be created within processes or existing ones can be assigned to solution processes.

Create or Assign Documents within Solution Process.

Through the assignment to the process, the document gets part of a scope.

The figure illustrates the relation to the process hierarchy.

You can organize your processes and documents using the Process Hierarchy.

Documents can be assigned to one or multiple hierarchy nodes.

The figure highlights the tab to assign references.

Add any extra external sources to your document or link to external files.

The figure explains the available editing status.

The figure explains the available editing status.

The figure shows the report: Documents List View.

The figure shows the report: Documents List View. It offers:

  • Review available project related documents.
  • Filter documents.
  • Sort and group documents.
  • Save personalized views.
The figure explains the Import- and Export using MS Excel.

The figure explains the Import- and Export using MS Excel.

The figure explains the display of documents in the Project Overview Dashboard.

The figure explains the display of documents in the Project Overview Dashboard.

The figure explains the display of documents in the Solution Process Traceability.

The figure explains the display of documents in the Solution Process Traceability.

Log in to track your progress & complete quizzes