Esta seção reúne tudo o que você precisa para entender, utilizar e operar este projeto.

A documentação está organizada para atender diferentes momentos de uso: desde o primeiro contato até a operação e evolução do sistema. Em vez de concentrar todas as informações em um único formato, o conteúdo foi dividido em tipos distintos, cada um com um propósito claro.

Essa organização segue o modelo Diátaxis, que separa a documentação de acordo com a necessidade de quem consulta.

Como navegar

A documentação está dividida em quatro seções principais:

Tutoriais

Guias passo a passo para começar. Aqui você aprende fazendo, seguindo um fluxo completo até chegar a um resultado funcional.

Use esta seção quando estiver começando ou quando quiser entender como as partes do sistema se conectam na prática.

Como Fazer

Instruções diretas para resolver tarefas específicas. São conteúdos objetivos, voltados para quem já conhece o básico e precisa executar uma ação.

Use esta seção quando souber o que quer fazer, mas precisa de orientação prática.

Referência

Descrição técnica detalhada do sistema. Inclui parâmetros, configurações, comportamentos e especificações.

Use esta seção quando precisar de informações precisas ou consultar detalhes específicos.

Explicações

Textos que aprofundam conceitos, decisões e funcionamento do sistema. Aqui você encontra o contexto por trás das escolhas técnicas.

Use esta seção para entender como e por que o sistema foi construído dessa forma.

Como usar esta documentação

Cada tipo de conteúdo atende a uma necessidade diferente. Em vez de ler tudo em sequência, o ideal é acessar a seção que corresponde ao seu momento:

• Se está começando: vá para Tutoriais

• Se precisa resolver algo específico: vá para Como Fazer

• Se precisa de detalhes técnicos: consulte a Referência

• Se quer entender melhor o sistema: leia as Explicações

Objetivo

O objetivo desta documentação é tornar o sistema compreensível, utilizável e sustentável ao longo do tempo. Isso inclui não apenas instruções, mas também contexto e clareza sobre como cada parte funciona.