O conteúdo dessa seção foi organizado para atender diferentes necessidades. Há materiais para quem está começando, guias para executar tarefas específicas, documentação de referência para consulta técnica e textos que explicam conceitos e decisões adotadas ao longo de implementações.
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á organizada por temas relacionados aos componentes e serviços utilizados no programa. Cada tema reúne quatro tipos de conteúdo, cada um com um objetivo específico:
Tutoriais
Os Tutoriais são voltados para quem está tendo o primeiro contato com um tema. Eles apresentam atividades guiadas, passo a passo, para que seja possível aprender na prática e concluir uma tarefa completa.
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 reúne instruções objetivas para realizar tarefas específicas ou resolver problemas pontuais. Esses guias assumem que você já conhece o básico do assunto e precisa apenas de orientação para executar uma atividade.
Referência
A seção de Referência concentra informações técnicas para consulta, como configurações, parâmetros, comandos, estruturas e demais detalhes necessários durante a operação e a manutenção de algo.
Explicações
Enquanto as seções anteriores focam na execução, as Explicações apresentam o contexto por trás das soluções adotadas. Nessa seção você encontra conceitos, princípios de funcionamento e decisões de projeto que ajudam a compreender como os diferentes componentes se relacionam e por que determinadas abordagens foram escolhidas.
Como usar esta documentação
Cada tipo de conteúdo atende a um momento diferente:
-
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