In this document we describe how document documentation is organized. Where information gets stored, who is involved and what are the goals and deadlines.

Single Entry Point

Every project has to have a Project inside our GitHub Organization. The project has to be at organization level not inside a repository, because we need the overview/list of all our projects in one single place.

Minimal information about a project

In the description of every project on Github, the following data has to be included:

• Project name
• Single sentence describing the projects goal
• Contact to the project manager
• Link to the project website
• Link(s) to the folder(s) to store and find all project documents
• Link(s) to repository(ies)
• Link(s) to communication channel(s) (RIOT, ...)
• Link(s) to tool(s) (Jenkins, ...)

Project Folder

Every project needs a shared folder, where all documents (technical docs, PDFs, presentations, ...) are stored and shared with the project team. The folder has also be shared with all members of the Tech-Transfer Unit Digital.

For naming folders and files we should use PascalCase, English, no spaces. For filenames we should use the following format:

yyyymmdd-FileName.extension

Sub-folder Structure

• /Meetings/ (includes a single file per meeting, someone attended to)

Project Status and Progress

All tasks/user stories for internal team members and external service providers have to be managed in the GitHub project Kanban. This will ensure, that every Tech-Transfer Unit Digital team member has access to all status information whenever needed.

We plan project deliverable deadlines using milestones

We assign user stories/issues to milestones to define the deadlines for these issues.