Documentation

Documentation

This page offers an overview of all Documentation capabilities in SAP Cloud ALM.

The "Documents" app was just released and will be the future solution for solution documentation. The "Notes" functionality will still remain for a while and then all Notes will be migrated to "Documents". More information will be released once the migration is planned.

In future we will invest in extending the documentation capabilities in SAP Cloud ALM – for more information please watch this RECORDING.

For basic “How-To” instructions on how to use the tool, you should refer to the in-app help within SAP Cloud ALM or visit the SAP Help Portal.

Functions & Features

Documents

Help Portal link - Documents

Functions	Features	Feature Description
Documents overview	View Documents	Use the Document list view to see all documents of your project
Documents overview	Filter Documents	Filter your documents by scope, owner, status, created by/changed by, created on/changed on, etc
Documents overview	Add references	in case documentation is stored outside SAP Cloud ALM you can add one or more links to the external sources. you can maintain the URL and name the reference
Documents overview	Draft handling	To prevent data loss, all information maintained is always saved in a draft version. once the creator saves the changes, they are visible to others as well. you can see your draft documents in your list. you can also see if there are unsaved changed by you or others
Documents overview	Relations	You can assign documents to one or more relevant solution processes. in the solution process app the documents are shown then, also the solution process traceability shows the related documents by status
Create new Document	Create new Document	Create a new documentation elements with title and unique ID
Create new Document	Set Document Status	Select the document status from the values: In Progress, In Review, Released. The status can be used for filtering and grouping, it is also shown in the solution process traceability view
Create new Document	Maintain Document Owner	the owner of the document can be maintained. As a default the creator is set as the owner
Create new Document	Maintain Document Content	Using a rich text editor, the documentation can be maintained directly in SAP Cloud ALM. Content can also be copied, then the formatting can be kept or removed. Lists, tables and other options are available. Pictures are currently now sup

Notes

Functions	Features	Feature Description
Notes overview	View and Filter Notes	Use the Notes Overview page to see and filter all your notes in one list.
Notes overview	Download Notes to Exel	Export all notes with descriptions, references and tags
Create Notes	Create Notes in a Notes Overview	Create a note to add documentation to your project
Create Notes	Create Notes in Process Overview	Add a note to a process to store documentation of the process
Create Notes	Tag Notes	Tag Notes to categorize them
Create Notes	Create References	Use the references to add links to externally stored documents

Best Practices

How-To Videos

List of Links

Release Date

Recording ALM SUMMIT 2022:

Unlock the Value of the New Solution Documentation in SAP Cloud ALM

March 03, 2023

NEW!!!

Blog: Manage your project documentation using SAP Cloud ALM

June 29, 2023