Standard for documentation of Microservice in Microservice Directory

[HGustavs]

I believe we need a standard document/template for the microservice documentation

We want to document things such as

• Input Parameters incl format of each paramter
• Calling Method (get/post etc)
• Ooutput Data incl format
• General written documentation about functionality
• Example of use

Do we have any other information we want to convey?

Please add suggestions as comment to this issue

Once this standard has been decided we can start producing documentation for each service that can be tested against this template so that it conforms to that template.... but first we need to agree on the format.

[a23wilgr]

We could structure the documentation in a folder called "Microservices Documentation" where we create separate subfolders or documents for each microservice, instead of having all documentation in the same document. This would make it more structured and documentation for specific services would be easier to find.

One map called "Microservices documentation" that contains one folder "Shared microservices documentation" and "Sectioned services". This folders will then contain one md per service/file - so one md for ex. "getUid", another for "logUserEvent" in the "Shared microservices documentation" etc.

[b23johgu]

Example of template for the documentation:

Name of file/service

Description

Description of what the service do and its function in the system.

Input Parameters

Parameters will be described in tables for easier readability

Parameter	Type	Description
$exampleid	string	Example ID Description

Calling Methods

• GET
• POST
• etc.

Output Data and Format

Output Data will be described in tables for easier readability

Output	Type	Description
exampleid	string	Example ID Description

Examples of Use

CODE

Microservices Used

Includes and microservices used

[a23danme]

The example template looks really good! It covers the most important stuff, and I do not see any problems with it.