10.10 Handbook
This page explains how to contribute to the handbook.
Table of contents
How to suggest changes
- Navigate to the page you would like to change
- Click on “Help improve this page”, sign in, and the “Edit this file” button
- Add your changes in GitHub markdown
- Commit the changes to a new branch
- Assign the maintainer to review and merge your changes
Principles
- Checklists should be simple, structured, and actionable
- Add links to the confidential data store (see example)
- Add links to other parts of the handbook or external resources to avoid replicating content (e.g., to PDF forms that may be updated externally).
-
Terminology:
- SuSe / WiSe, not “SS / WS”.
- Team Assistant, not “Secretary”.
- Headings: Use sentence case for all headings and subheadings.
- Consistency: Maintain consistent formatting throughout the document, particularly for lists, tables, and citations.
- If the page requires scrolling, add a table-of-content. Exclude second-level headings from TOC.
# Heading
{: .no_toc }
## Table of contents
{: .no_toc .text-delta }
- TOC
{:toc}
...
### Heading 3
{: .no_toc }
Text with illustrations/figures/screenshots:

Note: copy and adapt the path as needed.
- We use the
resource
callout when resources (external to the handbook) are available. For example, confidential data, such as grades and student identities, should not be stored in the handbook.
{: .resource }
> Confidential data is stored on the [Nextcloud](http://url.com){: target="_blank"}.
Confidential data is stored on the Nextcloud.
- Avoid renaming files or changing the structure of directories. If files need to be renamed, include a redirect in the header:
---
layout: default
title: ...
redirect_from:
- /docs/20-research/20_processes/20.30.pre-submission.html
---
Deployment
The handbook is hosted on GitHub Pages. The deployment may take a few minutes to complete. You can check the status at
How to copy the handbook
To create a copy of the handbook, clone the repository.
More detailed instructions and best practices will be available shortly.