The preparation of comprehensive and sustainable technical documentation of a service is often given a low priority task, and may not even be part of planned development activities.
Yet it is absolutely essential – both for internal and external use – that associated code is clearly commented, dependencies on libraries are well documented, installation instructions are maintained and kept up to date and so on. In addition, providers should take action to document the progression of their services through the Technological Readiness Level scale.
In this workshop we will introduce different kinds of technical documentation, and best practices on what to cover and how to keep them relevant to different stakeholders and target audiences. The presentation will be followed by an interactive discussion, where participants can bring their own service use cases and get feedback and advice on the related technical documentation.
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 technical service documentation |
| 10:45-10:55 | Q&A |
| 10:55-11:00 | Short break |
| 11:00-11:35 | Interactive discussion and feedback on participants’ use cases |
| 11:55-12:00 | Next steps & wrap-up |
Speakers
Main instructor: Milica Sevkusic (EIFL/Institute of Technical Sciences of the Serbian Academy of Sciences and Arts)
Moderator: Maggie Hellström, University of Lund and ICOS Carbon Portal
Milica Ševkušić is a Project Coordinator for the EIFL Open Access Programme and librarian at the Institute of Technical Sciences of the Serbian Academy of Sciences and Arts. She has been involved in the development of the repository network in Serbia and is now coordinating user support for repositories at the University of Belgrade Computer Centre.
Registration
Register for the Zoom meeting here – deadline is close of business on September 28.