Service Guide
The service guide is the main documentation deliverable for technical and service, describing the service features, tasks and concepts.
As a rule of thumb, you can say that if a service appears in the SAP BTP cockpit under Services. you need to provide a service guide for it.
The service guide contains all the information required by the target groups on SAP BTP to decide on the relevance of the service for his or her application or scenario. These target groups include application developers, key users, administrators, and decision makers (purchasers). The guide also contains information about how to set up, consume, and run the service.
Some texts within the service guide will be reused by other repositories or places where the service appears (such as the service catalog and others).
Container
Decide together with your info architect on the container to be used for your service guide. We recommend creating a service-specific container for your service on level 6 using the continuous delivery (DEV/SHIP) container model.
See also: Initial Technical Setup
Service Guide Template
To ensure consistency of information across all service guides, a service guide template is provided in the form of a (this) wiki. This is to structure the content so that readers can find similar information instantly when reading multiple service guides. The template should also support you in gathering the information from your development teams.
The template consists of a number of chapters in a fixed sequence covering the different information needs of the target groups. It also contains a reuse topic that is called data sheet topic. This data sheet topic collects text fragments and other resources that can be reused in the documentation and other places, for example the marketplace. The topics Service Data Sheetand Tool Data Sheet are not contained in the output of the service guide, but they should be part of your buildable map to have all related information in one place.
Only the data sheet topics, the overview topic, and the What's New topic are available in Ixiasoft. Please check the respective wiki pages for details.
Title of Buildable Map for Service Guide
As a title of your buildable map, you should use the long name approved by Brand Voice for your service.
For more information about service names, see Service Names and Descriptions
If your service is available in both the Neo and Cloud Foundry environment, provide both documentation sets within the same deliverable.
Structure of Buildable Map
<div> <div>Topic</div> <div>Target Group</div> <div>Content</div> <div>Mandatory / Optional</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2FhLb8NEAS1GrEBiSqezQK1TgR6JidCu6EbWurJaVJ7go">What Is <Service Name>?</a></div> <div> <p>Purchaser</p> <p>Application developer</p> <p>Account administrator</p> <p>Application administrator</p> <p>Solution architect</p> </div> <div> <p>Gives an overview of the goals, advantages, and features of a service.</p> <p>The target groups should be able to decide whether the service is applicable to them based on this document. It answers basic questions like, "What is the service? What does it do? What are its advantages or main use case?"</p> </div> <div>Mandatory</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fdesign-system%2Fbtp%2Fwriting-guidelines%2Fproduct-specifics%2Fservice-guide-template%2Fcommercial-information%2F">Commercial Information</a></div> <div> <p>Purchaser</p> <p>Solution architect</p> </div> <div> <p>Gathers all information needed for the customer to understand the relationship between the content of the Discovery Center and the content</p> <p>of the BTP Cockpit, as well as any information needed to understand how the service is billed.</p> </div> <div>Mandatory for the services using capacity units as metrics</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2FeSTbbT3J9UhyZ_NjzhY-nzdw7MsrpWFllsy1ZemBXGE">What's New for <Service Name></a></div> <div> <p>Purchaser</p> <p>Application developer</p> <p>Account administrator</p> <p>Application administrator</p> </div> <div>Describes what is new as of a certain date.</div> <div>Mandatory</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2FXRahIIwc4etL6Ao3nz3xVa7_vLp-ahzPl7E2fz72mTo">Concepts</a></div> <div> <p>Account administrator</p> <p>Application developer</p> </div> <div>This chapter defines the basic terms, objects and entities of the service and describes their relationship to each other.</div> <div>Optional</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fdesign-system%2Fbtp%2Fwriting-guidelines%2Fproduct-specifics%2Fservice-guide-template%2Finitial-setup%2F">Initial Setup</a></div> <div> <p>Application developer</p> <p>Account administrator</p> </div> <div> <p>This chapter summarizes the tasks that need to be performed when setting up the service in a subaccount and enabling it to be consumed by a target application. These tasks include:</p> <ul> <li>Creating and binding a service instance (required for all services)</li> <li>Setting up destinations (only in some services)</li> <li>Setting up roles, authorizations, permissions, backend systems and others (only in some services)</li> </ul> <p>These tasks are typically done in the SAP BTP Cockpit or a console tool (CLI/kyma console/cubectl, etc.)</p> <p>Note: Describe here the one-time technical configuration tasks required for setting up the service for the first time. All other configuration tasks describe in the section.</p> </div> <div>Mandatory</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2FLDrbm6v6G-PgOfpyqYxvR9ERPZEOXGdWjQ68bsNNp2c">Development</a></div> <div>Application developer</div> <div>This chapter details the tasks and procedures that are relevant for the application developer when adjusting the application itself in order to enable it to consume the service. This information might be provided within one or multiple topics. Create/migrate all your tutorials in the Tutorial Navigator and link them from here.</div> <div>Optional</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2FUm9k0EsA1LgsbZp8O-GjsYfOSziwokbwPhBYKsiO01E">Administration</a></div> <div> <p>Application developer</p> <p>Service operator</p> </div> <div></div> <div>Optional</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fdesign-system%2Fbtp%2Fwriting-guidelines%2Fproduct-specifics%2Fservice-guide-template%2Fintegration-section-title-integrating-with-system-name-topic-titles%2F">Integration/Integrating the Service with <System Name></a></div> <div> <p>Account administrator</p> <p>Application developer</p> </div> <div>This chapter summarizes the tasks that need to be performed when integrating the service with another system outside SAP BTP, such as SAP S/4 HANA on-premise system or SAP S/4 HANA Cloud.</div> <div>Optional</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2FVVwlzo8uOo9KFkmV-60sAkIE8Bj_QQp0_s4KTi0y-Ew">Service Consumption at Application Runtime</a></div> <div>Application administrator</div> <div>This chapter is optional and only required if your service offers functionality that is configurable or visible within the consuming application. It may, therefore, contain the configuration information that is relevant for the application administrators or user information that is relevant for the end-users of the application.</div> <div></div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2F3Bd5BC_cdQFat0iSsKUkaiB5RD8WHQyc2MuZfYzZj20">Configuring <Service Name></a></div> <div>Application administrator</div> <div>These tasks differ from the technical configuration tasks described in "Initial Setup".</div> <div>Optional</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2F7zcZBMt63h5CAwJMnGcrQPOnUiYiJpbRDiMRCwxWgQs">Using <Service Name></a></div> <div> <p>Application administrator</p> <p>Application end-user</p> </div> <div>This chapter is optional and is only necessary if your service offers functionality that is visible to end-users of the consuming applications.</div> <div>Optional</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2FIFwTWCe4ne7y9nVQuci-PG6jKUetZl4WpM2ptopbbgc">Security</a></div> <div> <p>Application developer</p> <p>Account administrator</p> <p>Application administrator</p> </div> <div>This chapter is meant to alert the account administrator or application administrator to settings and configurations that are relevant to operating their service in a secure manner, for example, regarding users or authorizations. It provides on how to configure and operate the service. It describes only the recommended procedures that a user or administrator should perform.</div> <div>Mandatory</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2Fzz23cSg-VubmiIyfX7xZ67YPwAn1DqrEUfflj2OHZWs">Monitoring and Troubleshooting</a></div> <div>Application administrator</div> <div> <p>This chapter summarizes the steps and tools for dealing with problems, glitches, outages and other unexpected situations with the service. The goal is to:</p> <ul> <li>Enable the customer solve the problem on his/her own using existing troubleshooting resources (Guided Answers tree, see the note below). The easier to find and the better the resources, the less likely the customer will be to create support tickets.</li> <li>If he/she still cannot find a solution, contact SAP support.</li> </ul> </div> <div>Mandatory</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fr%2F4BtfbhoeFrU-mU40WFMDYEO5xC3nRcaru4LEeLjPhs4">Accessibility Features</a></div> <div> <p>Application developer</p> <p>Application administrator</p> </div> <div>This chapter is mandatory and summarizes the accessibility features that are available for your service. It should let users with special needs know if they can use the service without problems or if they need to do any configuriation beforehand.</div> <div>Mandatory</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fdesign-system%2Fbtp%2Fwriting-guidelines%2Fproduct-specifics%2Fsap-btp-services%2Fservice-data-sheet%2F">Data Sheet topic</a></div> <div></div> <div> <p>Contains reuse texts that appear in different places:</p> <ul> <li>Overview topic in service guide</li> <li>Service catalog</li> <li>SAP BTP cockpit</li> </ul> </div> <div> <p>Mandatory</p> <p>in the output that is generated from that buildable map.</p> </div> </div>
Frequently Asked Questions
No. You only need to rework your existing deliverable so it matches the new template. Provide the chapters from the template with the specified chapter titles. Add your existing content underneath those chapters.
No, the template is only here in this wiki chapter.
No. The deliverable title is still the long service name approved by BrandVoice.
No. No root topic or section. All sections mentioned in this template are on the same level.