004 - Documentation

1. Format

Dokumentation MUSS im Markdown Format erstellt werden.

Empfohlene Editoren:

2. Setup Guide

Jedes Projekt MUSS ein Setup Guide enthalten.

Das Setup Guide MUSS im Projekt-Root unter README.md hinterlegt werden.

Das Setup Guide MUSS Anweisung zur lokalen Installation des Projektes enthalten, anhand derer das Projekt zum Laufen gebracht und automatisierter Tests ausgeführt werden können.

Struktur

# Projektname

## Setup

...

## Testing

## Directory Structure (optional)

## Troubleshooting (optional)

3. Changelog

Es MUSS eine Changelog Datei im Projekt-Root unter CHANGELOG.md nach folgendem Muster angelegt werden (siehe https://keepachangelog.com/en/0.3.0/):

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.3.0] - under development

### Added
- Some new Feature
- Another new Feature

### Changed
- Some change

### Fixed 
- Some bugfix

### Removed

## [0.2.0] - 2020-01-01

...

4. Code comments

5. Developer Guide

Ein developer guide SOLLTE angelegt werden, wenn ein Bereich des Quelltextes zusätzliche Informationen zum Verständnis benötigt.

Das developer guide MUSS mit mkdocs in einem seperaten Docker Container (z.B. mit https://hub.docker.com/r/polinux/mkdocs) angelegt werden.

6. API Dokumentation

Eine API Dokumentation KANN nach eigenem Ermessen angelegt werden.

Die API Dokumentation MUSS automatisiert aus den Kommentaren im Quelltext erstellt werden können.

hinweise

7. Anwenderdokumention

Über die Notwendigkeit einer Anwenderdokumentation wird auf Projektbasis entschieden.