Clear and comprehensive documentation is absolutely essential for a service – or any resource – 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 description (answering the questions What? For whom? and Why use?) is a required metadata item to be provided during the onboarding of all resources into the EOSC Marketplace.
In this workshop, we will start by giving an overview of relevant documentation types, and discuss some strategies for creating sustainable, effective and end-user-friendly descriptions. This will be followed by practical hands-on exercises focusing on how to prepare service descriptions according to the requirements of the EOSC onboarding protocol.
So bring your own service use case along, and join what we hope will be an interactive and productive description writing session!
Agenda
| 10:00-10:05 | Welcome & “housekeeping” |
| 10:05-10:25 | Service documentation: what, why & how – Maggie Hellström |
| 10:25-10:50 | Exercise 1: examples of service descriptions in the EOSC Marketplace |
| 10:50-11:00 | Break |
| 11:00-11:50 | Exercise 2: describe your own service! |
| 11:50-12:00 | Summary & wrap-up |
Speakers
Main instructor:
Dr Maggie Hellström – research data management specialist at the ICOS Carbon Portal and co-lead of the work package on training & capacity building of the ENVRI-FAIR cluster project.
Registration
Zoom Registration – Deadline: August 28, Close of Business