ILIAS Universität Bern
  • Login
Show Sidebar

Breadcrumb Navigation

Icon Course

2020-06-18 Software Documentation Techniques (13:30-17:00)

How to efficiently document software.

Tabs

About this training
Documentation

Good ethics and best practices when working on software and data science projects include good documentation. In this half day course we learn how to use tools like GitHub and ReadTheDocs to document our projects.

The course is mandatory and free for CAS Applied Data Science participants. 
https://opensource.googleblog.com/2018/10/building-great-open-source-documentation.html

Learning outcomes - participants
  • know different levels and types of software documentation
  • can use documentation generators like sphinx 
  • can document with Markdown and RST
  • can use GitHub and ReadTheDocs for automatic and versioned public webpage documentation
Target group
  • People working on (research), or intend to work on, software and data science projects, individually or in teams.
Prerequisites 
  • Participants must bring own laptops.
Certificate 
  • A certificate will be delivered to participants who have attended the whole training. The certificate is valid as one half day in module 4 of the CAS Applied Data Science.
Coaches
  • PD Dr. Sigve Haug
Practical information (time, location ...)
Time : 2020-06-18 13:30 - 17:00
Location : Online and at Mittelstrasse 43 Room 124 (max. 10 people on the spot)
Online Room: Only visible for registered participants 

On-Site Registration:

Only 10 people are allowed to be in the room at Mittelstrasse. If you would like to be there in person, please sign up here (mandatory): https://doodle.com/poll/hi68vm399driyunh

Please also read the university COVID measures information (german only) linked below.

The first 10 will be allowed. All other participants must attend remotely. The lecturer will sit in the room, however, giving the course just the same way as from home office. So there shouldn't be a big difference between remote and on-site participation.  

Training language: English
Participants : Max 24
Registraion : Mandatory
Coaches : PD Dr. Sigve Haug
Prerequisites : Laptop, minimal Linux and programming experience
Certificate : Certificate for full training attendance
About the coaches and ScITS
PD Dr. Sigve Haug

Sigve studied physics in Germany, Spain and Norway. He has been involved in neutrino physics experiments and high energy frontier experiments, often with main focus on the computing challenges related to the large and distributed data from these experiments. Today he is working for the Albert Einstein Center for fundamental Physics and the Mathematical Institute of the University of Bern where is leading the Science IT Support unit. 

The Science IT Support is there to boost your research by supporting you solving computing challenges. 
Your code doesn't compile, you need more computing power, more storage, a data mangament plan and
so on - drop an email, call or pass by our office. 

Our wepgabe is scits.unibe.ch.