> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Templates de guias

> Adote os templates oficiais da Lerian para docs narrativas — visões gerais, arquitetura, primeiros passos, referências de entidades e guias práticos.

Esta página fornece os templates oficiais para toda documentação narrativa e orientada a tarefas no ecossistema Lerian: visões gerais de produtos, páginas de arquitetura, guias de primeiros passos, referências de entidades, guias práticos e visões gerais de plugins.

Esses templates refletem a estrutura e os padrões estabelecidos na documentação do Midaz. Use-os como ponto de partida para qualquer nova página. Aplique as regras de [voz e tom](/pt/partners-hub/voice-tone) e [capitalização](/pt/partners-hub/capitalization) independentemente de qual template você usar.

Para documentação de endpoints de API, consulte [Templates de referência de API](/pt/partners-hub/api-reference-template).

## Página de visão geral do produto

***

O ponto de entrada para um produto ou plugin. Responde três perguntas: o que é, por que usar e como funciona.

<Steps>
  <Step title="Título e subtítulo">
    Use "What is \[Product]?" como título. Adicione um subtítulo de uma linha no campo `description` do frontmatter que resuma o produto em linguagem simples.

    ```yaml theme={null}
    ---
    title: "What is [Product]?"
    description: "[Product] does [X] for [audience]."
    ---
    ```
  </Step>

  <Step title="Parágrafo de abertura">
    Duas a três frases. Declare o que o produto é, o que faz e onde se encaixa no ecossistema Lerian. Mencione o modelo de licenciamento (source-available para o Midaz e o Fetcher, ou Enterprise / licenciado para outros produtos) e link para o repositório público no GitHub apenas quando o produto for source-available; caso contrário, indique que seu repositório é mantido internamente.

    <Tip>
      Referência: [What is Midaz?](/pt/midaz/what-is-midaz) abre com um único parágrafo que cobre definição do produto, licenciamento e disponibilidade do código-fonte. Para produtos que não são source-available, consulte [What is Reporter?](/pt/reporter/what-is-reporter) para a redação recomendada.
    </Tip>
  </Step>

  <Step title="Por que usar [Product]">
    Enquadre o problema que o produto resolve. Use uma lista de bullets para as principais propostas de valor. Cada bullet começa com um rótulo em negrito seguido de dois pontos e uma explicação de uma linha.

    ```markdown theme={null}
    * **Own your ledger**: Source-available means full transparency and no vendor lock-in
    * **Move fast**: Modular architecture lets you add products without re-architecting
    ```
  </Step>

  <Step title="O que [Product] faz">
    Liste as capacidades principais como bullets. Siga com uma subseção "Built for" se o produto atende públicos distintos (fintechs, bancos, empresas).
  </Step>

  <Step title="Casos de uso comuns">
    Use um `<AccordionGroup>` com 3-5 casos de uso. Cada accordion tem um título curto e uma descrição de 2-3 frases do cenário.

    ```jsx theme={null}
    <AccordionGroup>
      <Accordion title="Digital banking">
        Launch checking accounts, savings products, and instant transfers.
      </Accordion>
    </AccordionGroup>
    ```
  </Step>

  <Step title="Como [Product] funciona">
    Use um componente `<Steps>` para guiar o fluxo de trabalho de alto nível (4-6 passos). Cada passo tem um título baseado em verbo e uma explicação de 1-2 frases.
  </Step>

  <Step title="Integrações (opcional)">
    Uma tabela mapeando produtos Lerian relacionados ao que eles adicionam.

    | Produto                                | Integração                                                      |
    | -------------------------------------- | --------------------------------------------------------------- |
    | [Matcher](/pt/matcher/what-is-matcher) | Reconcilia transações do ledger contra fontes de dados externas |
  </Step>

  <Step title="Próximos passos">
    Um `<CardGroup cols={2}>` com 3-4 cards apontando para: arquitetura/conceitos, início rápido, casos de uso e referência de API.
  </Step>
</Steps>

**Páginas de referência:** [What is Midaz?](/pt/midaz/what-is-midaz) · [What is CRM?](/pt/midaz/crm/crm-overview) · [Pix in Lerian](/pt/rails/pix/pix-overview)

## Página de arquitetura e conceitos

***

Explica a estrutura interna de um produto -- seus domínios, entidades e como se relacionam. Esta é a página "Sobre \[Product]".

<Steps>
  <Step title="Parágrafo de abertura">
    Um parágrafo que posiciona o produto arquiteturalmente. Mencione o domain-driven design se aplicável.
  </Step>

  <Step title="Domínios ou componentes">
    Divida o produto em seus domínios lógicos (ex.: Domínio de Onboarding, Domínio de Transações). Cada domínio recebe um heading H3 com:

    * Uma breve descrição do seu propósito
    * Uma lista de bullets dos seus componentes, cada um com um nome em negrito e uma definição de uma linha

    Use tooltips de glossário para termos específicos do domínio na primeira menção:

    ```jsx theme={null}
    <GLedger>Ledger</GLedger>
    ```
  </Step>

  <Step title="Tabela resumo">
    Finalize com uma seção "Em resumo" contendo uma tabela que mapeia domínios ao seu propósito e APIs principais.

    | Domínio        | Propósito                | APIs principais                |
    | :------------- | :----------------------- | :----------------------------- |
    | **Onboarding** | Estrutura e configuração | Organizations, Ledgers, Assets |
  </Step>
</Steps>

**Página de referência:** [About Midaz](/pt/midaz/about-midaz)

## Página de primeiros passos

***

Um tutorial prático que leva o leitor do zero a uma configuração funcional. Objetivo: menos de 15 minutos.

<Steps>
  <Step title="Título e subtítulo">
    Use "Getting started with \[Product]" como título. O subtítulo deve definir expectativas: o que o leitor vai realizar e quanto tempo leva.
  </Step>

  <Step title="Pré-requisitos">
    Uma tabela listando ferramentas necessárias com versões mínimas e comandos de verificação.

    | Ferramenta | Versão mínima | Comando de verificação |
    | ---------- | ------------- | ---------------------- |
    | Go         | 1.24+         | `go version`           |

    Adicione uma `<Note>` para compatibilidade de SO.
  </Step>

  <Step title="Passos numerados">
    Cada passo é um H2 com o formato "Step N -- \[Verbo] \[objeto]" (ex.: "Step 1 -- Clone the repository"). Dentro de cada passo:

    * Uma explicação de 1-2 frases do que o passo faz e por quê
    * Um bloco de código com o comando exato
    * Uma `<Tip>` ou `<Note>` para detalhes importantes (portas, valores padrão, pegadinhas)

    Link para a referência completa da API para cada endpoint usado:

    ```markdown theme={null}
    <Tip>
      Para a especificação completa do endpoint, consulte [Create an Organization](/pt/reference/midaz/create-an-organization).
    </Tip>
    ```
  </Step>

  <Step title="Passo de verificação">
    Sempre inclua um passo final que confirme que a configuração funciona (ex.: verificar um saldo, consultar um endpoint de status).
  </Step>

  <Step title="Próximos passos">
    Um `<CardGroup cols={2}>` apontando para entidades, transações, casos de uso e explorador de API.
  </Step>
</Steps>

**Página de referência:** [Getting started with Midaz](/pt/midaz/midaz-getting-started)

## Página de referência de entidade

***

Documenta uma única entidade principal (Account, Ledger, Transaction, Holder, etc.). Explica o que é, como se comporta e como usar.

<Steps>
  <Step title="Definição de abertura">
    Um parágrafo definindo a entidade, seu papel no sistema e seu relacionamento com outras entidades.
  </Step>

  <Step title="Conceitos principais">
    Explique comportamentos e regras-chave. Use subseções H3 para conceitos distintos. Inclua diagramas (`<Frame>`) quando os relacionamentos são complexos.
  </Step>

  <Step title="Exemplos de código">
    Use `<CodeGroup>` para mostrar exemplos JSON e DSL lado a lado quando ambos forem suportados. Use payloads realistas.

    ````markdown theme={null}
    <CodeGroup>
       ```json JSON Example
       	{ "name": "Revenue Account", "assetCode": "BRL", "type": "deposit" }
       ```
       ```go DSL Example
       	(from @revenue :amount BRL 1000)
       ```
    </CodeGroup>
    ````
  </Step>

  <Step title="Diagramas visuais">
    Use `<Frame caption="Figura N. Descrição">` para diagramas de arquitetura, fluxo ou relacionamento de entidades.
  </Step>

  <Step title="Páginas relacionadas">
    Link para a referência de API, entidades relacionadas e guias relevantes.
  </Step>
</Steps>

**Páginas de referência:** [Transactions](/pt/midaz/transactions) · [Accounts](/pt/midaz/accounts) · [Holders](/pt/midaz/crm/holders)

## Página de guia

***

Explica como realizar uma tarefa específica ou implementar um caso de uso. Orientada a tarefas e contextual -- explica o "porquê" junto com o "como".

<Steps>
  <Step title="Contexto de abertura">
    Um a dois parágrafos explicando o que o leitor vai realizar, para quem é o guia e qual problema resolve. Seja específico -- não "aprenda sobre X" mas "configure X para lidar com Y".
  </Step>

  <Step title="Pré-requisitos">
    O que já deve estar configurado ou compreendido. Link para páginas relevantes.
  </Step>

  <Step title="Instruções passo a passo">
    Use seções H2 para fases principais. Dentro de cada fase, use passos numerados ou componentes `<Steps>`. Comece cada passo com um verbo.

    Inclua:

    * Blocos de código com payloads realistas
    * `<Tip>` para boas práticas
    * `<Warning>` para armadilhas comuns
    * `<Note>` para contexto importante
  </Step>

  <Step title="Verificação">
    Como o leitor confirma que a tarefa foi concluída com sucesso.
  </Step>

  <Step title="Próximos passos">
    Cards ou links para guias relacionados, conceitos mais aprofundados ou referências de API.
  </Step>
</Steps>

<Warning>
  Mantenha o guia principal focado. Se uma seção crescer além do escopo da tarefa (aprofundamentos de arquitetura, detalhes de algoritmos, design de segurança), mova para uma página filha separada e faça um link para ela.
</Warning>

**Páginas de referência:** [Getting started with CRM](/pt/midaz/crm/crm-getting-started) · [Pix plugin overview](/pt/rails/pix/pix-overview)

## Página de visão geral do plugin

***

Visões gerais de plugins seguem a mesma estrutura das [páginas de visão geral de produto](#página-de-visão-geral-do-produto), com estas adições:

* Declare claramente o modelo de licenciamento do plugin (por exemplo, source-available quando distribuído dentro do repositório do Midaz, ou Enterprise / licenciado caso contrário) e se requer uma licença.
* Especifique o **relacionamento de versionamento** com o Midaz (ex.: "A versão do CRM sempre corresponde à versão do Midaz Core").
* Inclua uma seção de **modelo de deploy**: como o plugin é implantado em relação ao Midaz (independentemente, mesmo namespace, etc.).
* Adicione uma seção de **requisitos** listando o que a instituição precisa para operar o plugin (ISPB, provedor de conectividade, maturidade de DevOps, etc.).
* Se aplicável, inclua uma seção de **trade-offs e desafios** que descreva honestamente as responsabilidades operacionais que o plugin introduz.

**Páginas de referência:** [What is CRM?](/pt/midaz/crm/crm-overview) · [Pix in Lerian](/pt/rails/pix/pix-overview) · [What is Fees Engine?](/pt/midaz/fees/fees-engine-overview)

## Padrões de componentes

***

Estes componentes Mintlify aparecem em todos os templates de guias. Use-os de forma consistente.

| Componente            | Quando usar                                                                                    |
| --------------------- | ---------------------------------------------------------------------------------------------- |
| `<Tip>`               | Boas práticas, recomendações, referências cruzadas para especificações de API                  |
| `<Note>`              | Contexto importante que não é um aviso (compatibilidade de SO, valores padrão)                 |
| `<Warning>`           | Armadilhas comuns, coisas que causarão erros se ignoradas                                      |
| `<Danger>`            | Informações críticas de segurança, riscos de perda de dados, responsabilidades de conformidade |
| `<Steps>`             | Fluxos de trabalho sequenciais (primeiros passos, como funciona)                               |
| `<AccordionGroup>`    | Casos de uso, configurações opcionais, detalhes expansíveis                                    |
| `<CodeGroup>`         | Múltiplos formatos de código para a mesma operação (JSON + DSL, bash + YAML)                   |
| `<CardGroup>`         | Próximos passos, páginas relacionadas                                                          |
| `<Frame>`             | Diagramas e ilustrações com legendas                                                           |
| Tooltips de glossário | Primeira ocorrência de termos específicos do domínio em uma página                             |