Breve descrição sobre a finalidade do serviço/módulo

1. Quick start

Instruções para a inicialização de maneira rápida da aplicação. Nesta seção não se deve entrar nos detalhamentos técnicos da aplicação. O Objetivo desta seção é apenas descrever como a aplicação pode ser inicializada da maneira mais simples possível.

2. Tecnologias empregadas

Nesta seção descreve-se sucintamente o conjunto de tecnologias empregadas para a elaboração da solução. Deve-se abordar no mínimo os temas:

2.1. Linguagem de programação

Informações acerca da linguagem de programação utilizada pela solução. Justificativa do emprego da linguagem escolhida.

2.2. Framework(s)

Informações acerca do framework empregado pela solução. Justificativa da escolha do framework.

2.3. Armazenamento dos dados

Descrever a solução de armazenamento de dados escolhida e sua justificativa

2.4. Outros temas

Outros temas são facultativos de acordo com a natureza da aplicação

3. Visão arquitetural

Espaço reservado para a descrição mais elaborada da arquitetura do módulo/serviço. Neste espaço deve-se agregar ao detalhamento técnico figuras que ilustrem a arquitetura adota na forma de diagramas.

4. Dependências

Neste espaço se detalha as dependências do projeto a outras soluções.

5. Configuração da aplicação

Espaço destinado para documentar as configurações possíveis para a aplicação (Ex.: profiles, variáveis de ambiente e etc.).

6. Configuração do armazenamento de dados

Detalhamento das ferramentas e configurações necessárias para implantação do ambiente de armazenamento de dados da aplicação.

7. Papeis e/ou recursos

Lista dos papeis e/ou grupos criados pela aplicação, bem como sua descrição acerca dos recursos aos quais dá permissão

8. Interações com o barramento de mensagens

Destinado a descrever as interações que a aplicação faz com o barramento de mensagem. Informando as filas que o serviço consome, os resultados do consumo das mensagens e as mensagens que envia ao barramento de mensagens.

8.1. Filas que escuta

Informar as filas escutadas pelo serviço e a interação que faz com as mensagens recebidas por estas filas

8.2. Mensagens que produz

Informar pontos da aplicação em que envia mensagens, bem como o corpo/payload dessas mensagens, descrevendo suas propriedades.

9. Interações com outros serviços

Documentar chamadas diretas síncronas ou assíncronas feitas a outros serviços

10. Eventos de webhook

Documentar os eventos da aplicação que são passíveis de interação via webhooks