Writing a module

---

W.I.P - results of management meeting at 2017-05-02

Defining a module

To start writing your module we have a set of questions to answer first. These questions will give you insight in what the module should consist of.

• Is my module self contained (is it dependent on a specific module)?
• Is my module atomic (not further devisable)?
• Does my module process logic?
• Does my module provide added value to the company and customers?
• Can my module be sold individually?
• Are the functionalities of my module clear and identifiable?
• Are the input and outputs of the system defined?
• Are the restrictions and usability of my module easy to read and is its purpose clear?
• Can my module be implemented into multiple projects?
• Are any necessary materials clearly described? Can they be ordered immediately?
• Is it clear how the module is invoked or how this module can be communicated with?

Module template

Add a markdown template for a refined module

# *Module title*
---

## Description
-

## Requirements
- list with requirements

## Functionalities
### Exposed functionalities
- list of functionalities visible to the user or module interfacing with this module
### Internal functionalities
- list of internal functionalities (implementation choices)

## Required hardware 

## Backlog-items
- link backlog item cards here

Module trello protocol

The following steps need to be taken to ensure a complete and correct module.

1. Create a card in the list "To be refined".
2. Write a module card according to the template.
3. Once you're done, place the card in the list "modules". Here it is ready for other people to review.
4. Once feedback, questions or suggestions are given on the card using a comment, the one who gave the comment will place your card back to "To be refined".
5. Reply to the comment and improve your if necessary the module.
6. Move the card back to "Modules" where it can receive feedback again.