Skip to content

Add a section for Protocol documentation #10

@ghost

Description

In a micro-service architecture such as that of our project, a lot of protocols may be defined to talk between components. The aim of such a documentation is mostly to be informative for other potential developers in the projects. As such it must explain:

  • The intent of the protocol (and why the need of this protocol)
  • Which components are involved
  • Where do the commands come from, where do they go
  • What transmission medium (if any) was chosen, and why

For each command, we also expect:

  • Intent of the command
  • Expected requests and expected responses
  • Description of the Data format in the transmission

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions