In order for a service – or any resource – to be successfully and correctly used, clear and comprehensive usage instructions are absolutely essential.
While those familiar with your organisation may only need a brief introduction to (new) features, potential new users will require much more detail – for example descriptions of how to interact with interfaces for both humans and machines, as well as examples of functionalities.
In some cases the format of choice for the instructional materials will be documents with text and images, but other situations may require multimedia like video or animations. Common to both, is a need for developers and communicators to work together to produce materials that work well for both advanced users and those new to the service!
In this workshop, we will be diving into the following topics:
● Different types of tutorials
● Planning and design
● Writing style and practical tips for content creation
● Tools for creating online tutorials
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:15 | Service documentation: what, why & how – Maggie Hellström |
| 10:15-10:45 | Introduction to tutorials & usage instructions |
| 10:45-10:55 | Q&A |
| 10:55-11:00 | Break |
| 11:00-11:35 | Breakout exercise: what do your end users need to know in order to use your services? |
| 11:35-11:55 | Discussion of the exercise outcomes |
| 11:55-12:00 | Next steps & wrap-up |
Speakers
Main instructor: Helen Clare, GÉANT/Jisc
Co-instructor and moderator: Maggie Hellström, University of Lund and ICOS Carbon Portal
Registration
Zoom registration – Deadline: September 7, Close of Business