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

No menu vertical à esquerda ou no final desta página, a documentação está organizada por tecnologias estudadas ao longo do projeto. Cada tecnologia foi estruturada em quatro seções principais:

Tutoriais

Os Tutoriais são projetados para o estágio inicial de contato com uma tecnologia. Seu objetivo principal é o aprendizado prático, conduzindo as pessoas por um fluxo contínuo até que alcancem um resultado funcional. Nesta seção, o foco não é a teoria exaustiva, mas sim permitir que quem consulta aprenda executando, estabelecendo uma base sólida sobre como os componentes do sistema se integram na prática.

Como Fazer (how-to guides)

Diferente dos tutoriais, os Guias de Tarefas (how-to guides), que nesta documentação são identificados como Como Fazer, partem do pressuposto de que quem acessa o conteúdo já possui conhecimento básico e busca atingir um objetivo ou resolver um problema pontual. São instruções objetivas e procedimentais voltadas para a execução de tarefas específicas, servindo como um recurso de consulta direta para pessoas que já sabem o que precisam realizar e buscam orientação técnica para concluir a ação com eficiência.

Referência

A seção de Referência constitui o inventário técnico do sistema. Ela oferece uma descrição rigorosa de parâmetros, configurações, comportamentos e especificações. Este é um conteúdo de natureza informativa e estática, essencial para momentos em que as pessoas necessitam de dados precisos e fatos técnicos exatos para fundamentar sua operação ou desenvolvimento.

Explicações

Enquanto as seções anteriores focam na execução, as Explicações dedicam-se ao entendimento do “porquê”. Este conteúdo aprofunda-se em conceitos, decisões de design e no funcionamento lógico. O objetivo é oferecer o contexto estratégico por trás das escolhas técnicas feitas durante o projeto, permitindo que pessoas interessadas compreendam a arquitetura de forma ampla e fundamentada.

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 e contato com a tecnologia:

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

• Se precisa realizar 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

Tecnologias