Clear and comprehensive documentation is absolutely essential for a service to be discoverable and successfully used – both by existing and potential new target groups. There are many components of service documentation, including service catalogue entries, promotional materials, usage instructions and tutorials, technical specifications and richly commented code. As an example of the first of these, a brief service description is a required metadata item to be provided during the onboarding of a service into the EOSC Marketplace.
We started off this event by giving an overview of documentation types, and discussed some strategies for creating sustainable and effective service descriptions. This was followed by practical hands-on exercises focussing on how to prepare service descriptions following the requirements of the EOSC service onboarding protocol.
Relive the moment
You can find the presentation of the event here. We hope this interactive session will help you write your own service descriptions.
Revisit the agenda
| Timing | Topic |
| 13:00 – 13:05 | Welcome & “housekeeping” |
| 13:05 – 13:25 | Service documentation: what, why & how |
| 13:25 – 13:50 | Exercise 1: examples of service descriptions in the EOSC Marketplace |
| 13:50 – 14:00 | Break |
| 14:00 – 14:50 | Exercise 2: describe your own service! |
| 14:50 – 15:00 | Summary & wrap-up |
There are no recordings available.