Inicio
Documentação
Recursos
Certificações
Comunidade
Notas - Guia de estilo e de escrita - Mercado Pago Developers

Busca inteligente powered by OpenAI 

Notas

Em nossa documentação, podemos incluir três tipos de notas:

  1. Nota simples: Serve para adicionar um dica ou recomendação que se queira destacar em um nível ligeiramente superior à documentação.

nota-simples

markdown

> Este é um exemplo de nota.
  1. Nota de esclarecimento: Serve para fornecer esclarecimentos sobre alguma etapa do processo que estamos documentando. Podem ser incluídas para redirecionar o leitor para outra etapa ou documentação, fornecer um contato para resolução de problemas, mencionar alternativas que possam ser úteis nessa parte do processo, entre outros.

nota-de-esclarecimento

markdown

> NOTE
>
> Título
>
> Corpo da nota.
  1. Nota de precaução: Serve para chamar a atenção do leitor em alguma etapa do processo. Pode ser incluída para indicar a necessidade de cumprir alguma etapa anterior, mencionar limitações que possam surgir, indicar uma versão/pagamento desatualizado, entre outros.

nota-de-precaucao

markdown

> WARNING
>
> Título
>
> Corpo da nota.