Documentation Guidelines

User manual

User documentation is created based on IEEE Std 1063-2001.

Developer Manual

REST-API documentation

Rest APIs are documented using OpenAPI specification. The following tools are recommendet for writing OpenAPI files:

• Swagger-Editor
• Stoplight.io

Rendering OpenAPI files inside mkdocs

For rendering OpenAPI files we use the mkdocs-render-swagger-plugin.

To be able to use mkdocs serve for rendering your API files install the plugin as root via pip (sudo pip install mkdocs-render-swagger-plugin) and make shure, that you have at leas mkdocs version 1.3.0 installed.