Informar o objetivo do conteúdo trago nesse documento, o que será mapeado e as funções usadas no aplicativo. Exemplo:
"Será desenvolvido um padrão de envio de dados...
O acompanhamento de um produto receberá o evento (produtoID), em decorrências de outros para parâmetros".
Informar a descrição de cada campo, e para que é utilizado. Exemplo:
Campo | Descrição |
---|---|
UserID | ID do usuário que irá ler o evento (usuário cadastrado para leitura). |
produtoID | ID do produto que irá ler o evento (usuário cadastrado para leitura). |
alertID | ID para aviso Sendo:
|
Informar Exemplo de funções que utilizam os campos acima, e a linguagem que utilizam.
{ "Viewer": [{ "userID": "00001", "produtoID": "01", "alert": [{ "alertID": "1", }] }, }