> ## 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.

# Plantillas de guías

> Adopta las plantillas oficiales de Lerian para docs narrativos — visiones generales, arquitectura, primeros pasos, entidades y guías prácticas.

Esta página proporciona las plantillas oficiales para toda la documentación narrativa y orientada a tareas en el ecosistema de Lerian: descripciones generales de productos, páginas de arquitectura, guías de inicio, referencias de entidades, guías prácticas y descripciones generales de plugins.

Estas plantillas reflejan la estructura y los patrones establecidos en la documentación de Midaz. Úsalas como punto de partida para cualquier página nueva. Aplica las reglas de [voz y tono](/es/partners-hub/voice-tone) y [capitalización](/es/partners-hub/capitalization) independientemente de la plantilla que uses.

Para documentación de endpoints de API, consulta las [Plantillas de referencia de API](/es/partners-hub/api-reference-template).

## Página de descripción general del producto

***

El punto de entrada para un producto o plugin. Responde tres preguntas: qué es, por qué usarlo y cómo funciona.

<Steps>
  <Step title="Título y subtítulo">
    Usa "What is \[Product]?" como título. Agrega un subtítulo de una línea en el campo `description` del frontmatter que resuma el producto en lenguaje simple.

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

  <Step title="Párrafo de apertura">
    Dos a tres oraciones. Indica qué es el producto, qué hace y dónde encaja en el ecosistema de Lerian. Menciona el modelo de licencia (source-available para Midaz y Fetcher, o Enterprise / con licencia para otros productos) y enlaza al repositorio público de GitHub solo cuando el producto sea source-available; de lo contrario, indica que su repositorio se mantiene internamente.

    <Tip>
      Referencia: [What is Midaz?](/es/midaz/what-is-midaz) abre con un solo párrafo que cubre definición del producto, licencia y disponibilidad del código fuente. Para productos que no son source-available, consulta [What is Reporter?](/es/reporter/what-is-reporter) para la redacción recomendada.
    </Tip>
  </Step>

  <Step title="Por qué usar [Product]">
    Enmarca el problema que resuelve el producto. Usa una lista con viñetas para las propuestas de valor clave. Cada viñeta comienza con una etiqueta en negrita seguida de dos puntos y una explicación de una línea.

    ```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="Qué hace [Product]">
    Lista las capacidades principales como viñetas. Continúa con una subsección "Built for" si el producto sirve a audiencias distintas (fintechs, bancos, empresas).
  </Step>

  <Step title="Casos de uso comunes">
    Usa un `<AccordionGroup>` con 3-5 casos de uso. Cada acordeón tiene un título corto y una descripción de 2-3 oraciones del escenario.

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

  <Step title="Cómo funciona [Product]">
    Usa un componente `<Steps>` para recorrer el flujo de trabajo de alto nivel (4-6 pasos). Cada paso tiene un título basado en un verbo y una explicación de 1-2 oraciones.
  </Step>

  <Step title="Integraciones (opcional)">
    Una tabla que mapea productos relacionados de Lerian con lo que agregan.

    | Product                                | Integration                                                 |
    | -------------------------------------- | ----------------------------------------------------------- |
    | [Matcher](/es/matcher/what-is-matcher) | Reconcile ledger transactions against external data sources |
  </Step>

  <Step title="Próximos pasos">
    Un `<CardGroup cols={2}>` con 3-4 tarjetas que apunten a: arquitectura/conceptos, inicio rápido, casos de uso y referencia de API.
  </Step>
</Steps>

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

## Página de arquitectura y conceptos

***

Explica la estructura interna de un producto -- sus dominios, entidades y cómo se relacionan. Esta es la página "About \[Product]".

<Steps>
  <Step title="Párrafo de apertura">
    Un párrafo que posiciona el producto arquitectónicamente. Menciona el domain-driven design si aplica.
  </Step>

  <Step title="Dominios o componentes">
    Divide el producto en sus dominios lógicos (ej., Onboarding Domain, Transaction Domain). Cada dominio obtiene un encabezado H3 con:

    * Una breve descripción de su propósito
    * Una lista con viñetas de sus componentes, cada uno con un nombre en negrita y una definición de una línea

    Usa tooltips de glosario para términos específicos del dominio en su primera mención:

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

  <Step title="Tabla resumen">
    Termina con una sección "En resumen" que contenga una tabla que mapee dominios a su propósito y APIs clave.

    | Domain         | Purpose                     | Key APIs                       |
    | :------------- | :-------------------------- | :----------------------------- |
    | **Onboarding** | Structure and configuration | Organizations, Ledgers, Assets |
  </Step>
</Steps>

**Página de referencia:** [About Midaz](/es/midaz/about-midaz)

## Página de inicio rápido

***

Un tutorial práctico que lleva al lector de cero a una configuración funcional. Objetivo: menos de 15 minutos.

<Steps>
  <Step title="Título y subtítulo">
    Usa "Getting started with \[Product]" como título. El subtítulo debe establecer expectativas: qué logrará el lector y cuánto tiempo tomará.
  </Step>

  <Step title="Prerrequisitos">
    Una tabla listando herramientas requeridas con versiones mínimas y comandos de verificación.

    | Tool | Minimum version | Check command |
    | ---- | --------------- | ------------- |
    | Go   | 1.24+           | `go version`  |

    Agrega una `<Note>` para compatibilidad de SO.
  </Step>

  <Step title="Pasos numerados">
    Cada paso es un H2 con el formato "Step N -- \[Verbo] \[objeto]" (ej., "Step 1 -- Clone the repository"). Dentro de cada paso:

    * Una explicación de 1-2 oraciones de lo que hace el paso y por qué
    * Un bloque de código con el comando exacto
    * Un `<Tip>` o `<Note>` para detalles importantes (puertos, valores por defecto, detalles)

    Enlaza a la referencia completa de API para cada endpoint usado:

    ```markdown theme={null}
    <Tip>
      For the complete endpoint specification, see [Create an Organization](/es/reference/midaz/create-an-organization).
    </Tip>
    ```
  </Step>

  <Step title="Paso de verificación">
    Siempre incluye un paso final que confirme que la configuración funciona (ej., verificar un saldo, consultar un endpoint de estado).
  </Step>

  <Step title="Próximos pasos">
    Un `<CardGroup cols={2}>` que apunte a entidades, transacciones, casos de uso y explorador de API.
  </Step>
</Steps>

**Página de referencia:** [Getting started with Midaz](/es/midaz/midaz-getting-started)

## Página de referencia de entidad

***

Documenta una sola entidad principal (Account, Ledger, Transaction, Holder, etc.). Explica qué es, cómo se comporta y cómo usarla.

<Steps>
  <Step title="Definición de apertura">
    Un párrafo que defina la entidad, su rol en el sistema y su relación con otras entidades.
  </Step>

  <Step title="Conceptos principales">
    Explica comportamientos y reglas clave. Usa subsecciones H3 para conceptos distintos. Incluye diagramas (`<Frame>`) cuando las relaciones son complejas.
  </Step>

  <Step title="Ejemplos de código">
    Usa `<CodeGroup>` para mostrar ejemplos JSON y DSL lado a lado cuando ambos sean compatibles. Usa 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 visuales">
    Usa `<Frame caption="Figura N. Descripción">` para diagramas de arquitectura, flujo o relación de entidades.
  </Step>

  <Step title="Páginas relacionadas">
    Enlaza a la referencia de API, entidades relacionadas y guías relevantes.
  </Step>
</Steps>

**Páginas de referencia:** [Transactions](/es/midaz/transactions) · [Accounts](/es/midaz/accounts) · [Holders](/es/midaz/crm/holders)

## Página de guía

***

Explica cómo lograr una tarea específica o implementar un caso de uso. Orientada a tareas y contextual -- explica el "por qué" junto con el "cómo".

<Steps>
  <Step title="Contexto de apertura">
    Uno a dos párrafos que expliquen qué logrará el lector, para quién es esta guía y qué problema resuelve. Sé específico -- no "aprende sobre X" sino "configura X para manejar Y."
  </Step>

  <Step title="Prerrequisitos">
    Qué debe estar ya configurado o comprendido. Enlaza a las páginas relevantes.
  </Step>

  <Step title="Instrucciones paso a paso">
    Usa secciones H2 para las fases principales. Dentro de cada fase, usa pasos numerados o componentes `<Steps>`. Comienza cada paso con un verbo.

    Incluye:

    * Bloques de código con payloads realistas
    * `<Tip>` para mejores prácticas
    * `<Warning>` para errores comunes
    * `<Note>` para contexto importante
  </Step>

  <Step title="Verificación">
    Cómo el lector confirma que la tarea se completó con éxito.
  </Step>

  <Step title="Próximos pasos">
    Tarjetas o enlaces a guías relacionadas, conceptos más profundos o referencias de API.
  </Step>
</Steps>

<Warning>
  Mantén la guía principal enfocada. Si una sección crece más allá del alcance de la tarea (análisis profundos de arquitectura, detalles de algoritmos, diseño de seguridad), muévela a una página secundaria separada y enlázala.
</Warning>

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

## Página de descripción general del plugin

***

Las descripciones generales de plugins siguen la misma estructura que las [páginas de descripción general de productos](#página-de-descripción-general-del-producto), con estas adiciones:

* Indica claramente el modelo de licencia del plugin (por ejemplo, source-available cuando se distribuye dentro del repositorio de Midaz, o Enterprise / con licencia en caso contrario) y si requiere una licencia.
* Especifica la **relación de versionado** con Midaz (ej., "CRM version always matches the Midaz Core version").
* Incluye una sección de **modelo de despliegue**: cómo se despliega el plugin en relación con Midaz (independientemente, mismo namespace, etc.).
* Agrega una sección de **requisitos** listando lo que la institución necesita para operar el plugin (ISPB, proveedor de conectividad, madurez DevOps, etc.).
* Si aplica, incluye una sección de **compromisos y desafíos** que describa honestamente las responsabilidades operativas que introduce el plugin.

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

## Patrones de componentes

***

Estos componentes de Mintlify aparecen en todas las plantillas de guías. Úsalos de manera consistente.

| Componente           | Cuándo usarlo                                                                                    |
| -------------------- | ------------------------------------------------------------------------------------------------ |
| `<Tip>`              | Mejores prácticas, recomendaciones, referencias cruzadas a especificaciones de API               |
| `<Note>`             | Contexto importante que no es una advertencia (compatibilidad de SO, valores por defecto)        |
| `<Warning>`          | Errores comunes, cosas que causarán errores si se ignoran                                        |
| `<Danger>`           | Información crítica de seguridad, riesgos de pérdida de datos, responsabilidades de cumplimiento |
| `<Steps>`            | Flujos de trabajo secuenciales (inicio rápido, cómo funciona)                                    |
| `<AccordionGroup>`   | Casos de uso, configuraciones opcionales, detalles expandibles                                   |
| `<CodeGroup>`        | Múltiples formatos de código para la misma operación (JSON + DSL, bash + YAML)                   |
| `<CardGroup>`        | Próximos pasos, páginas relacionadas                                                             |
| `<Frame>`            | Diagramas e ilustraciones con leyendas                                                           |
| Tooltips de glosario | Primera aparición de términos específicos del dominio en una página                              |