Desvendando a documentação

Documentação técnica e de negócios BigDataCorp.

Se você acabou de chegar por aqui, fique à vontade!

Este espaço foi pensado para ajudar você a encontrar rapidamente o que procura, seja para entender como uma solução funciona, conhecer orientações de uso ou mergulhar nos detalhes técnicos. Aqui, todas as páginas seguem um padrão de organização. Em outras palavras: aprendeu a navegar em uma, navegou em todas 😉 Isso deixa a experiência mais simples, intuitiva e sem surpresas ao longo do caminho.

Vamos lá?



🧭 Afinal, para que serve a documentação?

Pense na documentação como o seu guia de confiança. É aqui que você tira dúvidas, entende como as soluções funcionam, confere orientações importantes e encontra os detalhes técnicos quando precisar. Sempre que surgir uma pergunta — seja de negócio ou de integração — este é o melhor ponto de partida.


📚 Quais são as documentações da BDC?

A BigDataCorp organiza seu ecossistema em três frentes principais de documentação, cada uma voltada a um tipo de solução. Todas podem ser acessadas diretamente pela página inicial do portal , facilitando a navegação. Conheça cada uma delas:


Plataforma de Dados

Orientações técnicas e de negócios para integrar, configurar e utilizar a Plataforma de Dados.

Apps

Orientações técnicas e de negócios para integrar, configurar e utilizar os Apps.

Plugins

Orientações técnicas e de negócios para integrar, configurar e utilizar os Plugins.


🧭 Como cada documentação está organizada

As páginas estão estruturadas em duas abas principais:


📘 Guias

A aba "Guias" concentra os conteúdos voltados à visão de negócios e uso funcional das soluções. Você encontrará:

  • Descrições conceituais.
  • Contexto e cenários de aplicação.
  • Finalidades de uso.
  • Regras e boas práticas.
  • Orientações operacionais.

🚩

Objetivo desta aba: apoiar a compreensão estratégica e o uso adequado das tecnologias e produtos.


Documentação BigDataCorp - aba "Guias".


🛠 API Reference

A aba "API Reference" reúne a documentação técnica destinada a desenvolvedores e equipes de integração. Você encontrará:

  • Endpoints disponíveis
  • Parâmetros de requisição
  • Estruturas de resposta
  • Exemplos de chamadas
  • Detalhes de autenticação

🚩

Objetivo desta aba: viabilizar integrações, implementações e desenvolvimento técnico.


Documentação BigDataCorp - aba "API Reference".


📑 Explorando o menu lateral

O menu lateral, tanto da documentação de negócios quanto da técnica, funciona como o principal elemento de orientação dentro da documentação. Por meio dele, é possível acessar diretamente:

  • Seções e categorias
  • Tecnologias e produtos
  • Guias e referências técnicas
  • Conteúdos institucionais e relevantes para o cliente

Documentação BigDataCorp - explorando o menu lateral.


🚀 Próxima parada: Visão Geral

Agora que você já entende como a documentação funciona, é hora de começar a navegação de fato. Na seção Visão Geral , você encontrará as primeiras orientações, contexto inicial e o ponto de partida para explorar as funcionalidades, regras e detalhes da solução em questão.

E lembre-se: caso precise de qualquer suporte, nosso time estará sempre à disposição para ajudar 😉