The writing guidelines are a collection of SAP-wide and SAP BTP-specific guidelines that define how to write, create, structure, and publish user assistance deliverables for SAP BTP products. They focus on secondary help content, that is, help content that cannot be provided within the application.

The Vision

Our goal is to provide harmonized UA guidelines for all SAP BTP products. To achieve this, we started by collecting all of the available guidelines in the different products or product areas, and migrating them to the toolkit. Our next step will be to bring the UA experts from the different products together to define common guidelines for SAP BTP (where it makes sense).

The Content

Within the writing guidelines, we cover everything from writing basics, like tone of voice or grammar, to specific guidelines for the creation of help content, for example, service guides or product pages on SAP Help Portal.

The writing guidelines are the new home for BTP-wide guidelines, but we also provide an entry point to SAP-wide guidelines that are not owned by SAP BTP Design. You will find most of these guidelines in the Get Started - Basics of UA section. As they are owned by other groups at SAP, for example, by the central User Assistance or Brand Voice teams, we can only provide a short overview. Please follow the links in the sections to deep dive into those guidelines.

The Tools

Find a list of all UA tools and links for getting started in Tools.