End-User Guide
Product Specifics / SAP BTP Services
Introduction
This deliverable is optional and is only necessary if your service offers functionality that is visible to end-users of the consuming applications. It may be reused within the end-user documentation of the consuming applications. You may also link to it from the section Using <Service Name> in your service guide.
Basic Considerations
The following questions might help you when trying to determine whether you need to provide a separate end-user guide for your service:
- Does the service provide end-user UIs that are integrated into the SAP Fiori launchpad of the consuming application?
- Does the service provide UI components that can be integrated into UIs of the consuming applications?
- Does the service provide functionality that can be integrated into application UIs?
- Does the service provide content that is visible from an application UI?
Reuse of chapter within documentation of consuming applications
As this guide contains information that is relevant for the end-users of the consuming applications, your topics might be reused within the end-user documentation of the single consuming applications. There are different degrees of reuse possible:
- Service UIs are consumed without change and are visible within the Fiori launchpad of the consuming applications. In this case, and only in this case, we recommend to provide a s eparate end-user guide containing the end-user information for these UIs. This end-user guide can be reused within the end-user documentation of the consuming applications. See Procedure below.
- Service functionality is consumed without change and is integrated within the UIs of the consuming application. In this case, it might be possible that some of your topics provided within the section Using <Service Name> of your service guide are reused within the end-user documentation of the consuming documentation. The authors of the consuming applications will have to decide whether they want to reuse your topics or whether they will have to rewrite the documentation to match the different context in which the functionality appears. For more information, see Using <Service Name>.
- Service functionality or content (UIs or UI fragments) is adjusted by the consuming application before it is integrated into the UIs or the Fiori launchpad of the consuming applications. In this case, no reuse of the content of the section Using <Service Name> is possible. Authors providing the end-user documentation of the consuming applications will have to create the end-user documentation themselves. For more information, see Using <Service Name>.
Content
You may structure the content according to content visible to end-users of the consuming applications. If there is a sequence of steps, provide the structure accordingly.
If your service provides end-user UIs, authors of consuming application documentation may want to reuse your documentation in their application help. To make this possible, you need to make sure that your content is structured in a meaningful way:
- Your target group is your end-user. Make sure you know exactly who this is and address the information needs of your target group. If you have several end-users, for example an administrator and an end-user, make sure you separate the information for the different target groups.
- If you address the reader as "you", make sure that it is clear to whom you refer.
- Start with a topic that gives an overview.
- Create self-contained, reusable topics.
- Do not link to other topics outside of your submap.
- Do not mention your product name in your end-user documentation.
- Create at least one topic per UI.
Procedure
Create the end-user documentation for your service guide using the following procedure:
- Create a submap for your end-user documentation in your DEV container.
- Create the topics for your end-user documentation as children of your submap.
- Release your maps and topics, and push the topics, submap, and buildable map to your SHIP container.
- Make sure to send the LOIO of your submap to your translator and translation coordinator in addition to the LOIO for your buildable map.
- Include the submap into a separate buildable map to be able to publish it as a standalone deliverable on your product page.
The authors of the documentation for the consuming applications can then use either the entire submap or individual topics in their documentation. You can also create a submap for each Fiori application if necessary.