HOWTO Document the STM service This HOWTO describes

HOW-TO Document the STM service This HOW-TO describes how to document a service instance. • For MCP Service Registry • For Users • For Developers

Users of service instance documentation Two/three different users are identified for service instance documentation; • End-user (operational) of the service – Need to understand the operational usage and provision of the service – Need to understand the information need, e. g. schedule required • Configuration manager selecting service to use – Need to understand the given benefit and main purpose of the service – Need to understand the provider of the service, and the level of “authority”, hence is the provider trusted • Developer tailoring use of service – Need to understand the main exchange pattern of the service – Need to understand which operations that are available in the specific instance

Service Instance documentation Service Instance Description – for search Service Instance Description – for end-users Service Instance Description – for configuration managers and developers Template

Storage • MCP Service Registry – XML. description – Service Instance Document • Stmvalidation. eu – https: //www. stmvalidation. eu/developers-forum/service-catalogue/ – https: //www. stmvalidation. eu/user-forum/stm-user-guide/

Template for XML description The main purpose is to give a short presentation of the service to be presented when searching for services. The text shall be written to be presentable to operational end-user. No template has been created other than examples and guidelines.

Template for Service Instance Description For configuration managers and developers https: //www. stmvalidation. eu/developers-forum/service-catalogue/

Discussion The need to retrieve a operational description to be presented e. g. onboard has been identified, but the short description given by Service Registry is too short. And the instance documentation available in Service Registry is too big and includes too much technical information for the end-user. Therefore it has been discussed to add the possibility for enduser to retrieve a formatted operational description of the service that can be presented e. g. onboard, similar to the description in App store, Google play etc.