The writing guidelines bring together user assistance (UA) guidelines from different groups in SAP, and sometimes it can be confusing to understand which guidelines are relevant for you and where to start. Here's an overview of the different types of guidelines you should be aware of:
- SAP-wide User Assistance guidelines cover the standards and guidelines for technical communication at SAP. These guidelines apply to all SAP products, and they cover the basics of how to provide user assistance at SAP. In the toolkit, you'll find these guidelines mainly here in the Basics section.
- SAP BTP guidelines apply to all SAP BTP products and you'll find such guidelines in the UA Strategy and Deliverablessections.
- Product guidelines apply only to a certain SAP BTP area or product. Most of the time, they are a subset or clearer definition of the SAP-wide UA guidelines. We have collected these guidelines in the Product Specifics section.
In short, SAP-wide UA guidelines apply to all SAP products, but SAP BTP or other products (areas) might have more specific guidelines.
if you are new to user assistance and need to provide user assistance for a service on SAP BTP, start by familiarizing yourself with the SAP-wide UA guidelines. Once you've covered the basics, check if there are any specific guidelines available for SAP BTP and for your product area. And then you are all set!