Project documentation

This document explains the various project documentation- the types of documentation we have, intended audiences and where each type of documentation is stored.

Product documentation

The main product documentation contains information about how to install, configure and use the Monai workflow manager in a production environment.

Target audience: IT departments, system engineers, etc.

Where to Find It: this documentation doesn't yet exist, but it will be available on the monai docs website (https://docs.monai.io/en)

Developer documentation

This documentation describes the general architecture of the workflow manager, how it's built, and how it should be extended.

Target audience: developers - this includes developers working on the core implementation, as well as plug-in developers.

Where to Find It: within the guidelines folder in the project's root directory: https://github.com/Project-MONAI/monai-deploy-workflow-manager/tree/develop/guidelines.

Ways of working

These documents describe the team's ways of working, how the development team is organised and runs itself, and so on.

Target audience: members of the workflow manager sub-working group development team

Where to Find It: in the wiki - https://github.com/Project-MONAI/monai-deploy-workflow-manager/wiki