What are the writing guidelines?

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. Read more here.

How can I find out which guidelines are relevant for me?

Have a look at Which guidelines are relevant for me? where we explain how the different guidelines relate to each other.

Where can I find product-specific guidelines?

Product-specific guidelines are covered in the Products section.

Where can I find guidelines on UI texts?

Go to the design system relevant for your product area:

• Integration and Extension Tools Design System - UI Texts
• Database, Data Management and Analytics Tools Design System - Writing

Where can I find guidelines on SAP Companion content?

Go to the AppDev and Integration design system: SAP Companion.

Who can I contact if I have questions about a specific guideline?

Please note that we only provide support for the SAP BTP-owned guidelines, and not for the general guidelines owned by the central SAP User Assistance team. For the SAP BTP-owned guidelines, check the contact name in the section of the guidelines. You can find the sections at the end of each article, for example:

For the general guidelines owned by central User Assistance, please follow the links provided in the sections and get in contact with the respective owners.

I have some general questions/feedback.

You can reach out to the Writing Guidelines team by email.

For details about submitting feedback or feature requests, please refer to the Contact page.

How do I report a bug (typos, wrong images, incorrect content) in the guideline?

Please reach out to the Writing Guidelines team by email.