A Base de Conhecimento da TomTicket foi atualizada para oferecer uma experiência de leitura mais moderna, organizada e eficiente para empresas, clientes e desenvolvedores.
As novidades incluem uma reformulação completa das tabelas, melhorias de responsividade para dispositivos móveis, documentação de APIs com estruturas hierárquicas e interativas, novos cards informativos e blocos de código com destaque de sintaxe para diferentes linguagens de programação.
Com essas atualizações, ficou ainda mais fácil criar artigos claros, organizar informações técnicas e oferecer conteúdos de autoatendimento com uma apresentação profissional.
Neste artigo, conheça todas as melhorias implementadas na Base de Conhecimento da TomTicket.
O que mudou na Base de Conhecimento da TomTicket?
A atualização concentra-se em quatro áreas principais:
- tabelas mais modernas e responsivas;
- documentação de APIs mais organizada e interativa;
- cards informativos para destacar conteúdos importantes;
- blocos de código com destaque de sintaxe.
Esses recursos ajudam as empresas a estruturar melhor seus conteúdos, facilitando a consulta de informações por usuários, equipes de suporte e profissionais de desenvolvimento.
Tabelas mais modernas e com melhor experiência de leitura
A exibição de tabelas na Base de Conhecimento foi completamente reformulada.
O novo layout apresenta uma aparência mais limpa, moderna e profissional, tornando a leitura mais confortável até mesmo em artigos extensos ou em conteúdos que possuem grandes volumes de dados.
As tabelas podem ser utilizadas para organizar informações como:
- comparativos de recursos;
- listas de configurações;
- permissões de usuários;
- parâmetros técnicos;
- etapas de processos;
- planos e funcionalidades;
- informações de integração.
Além da atualização visual, as tabelas continuam respeitando as cores personalizadas configuradas pela empresa. Dessa forma, a Base de Conhecimento mantém a identidade visual da marca em todos os conteúdos publicados.
Tabelas responsivas em celulares e telas menores
Também foram realizados diversos ajustes de responsividade.
Agora, as tabelas adaptam-se melhor a dispositivos móveis, tablets e telas menores, proporcionando uma navegação mais confortável e reduzindo dificuldades durante a leitura.
Essa melhoria é especialmente importante para usuários que consultam artigos de suporte diretamente pelo celular, permitindo que encontrem informações rapidamente, independentemente do dispositivo utilizado.
Documentação de APIs mais organizada e interativa
A documentação técnica de APIs também recebeu uma grande evolução.
Agora, é possível documentar parâmetros de entrada e estruturas de retorno em um formato hierárquico, que é convertido automaticamente em uma tabela interativa.
Objetos e arrays podem ser expandidos ou recolhidos de acordo com a necessidade do usuário. Isso facilita a navegação em estruturas JSON mais extensas e complexas, sem sobrecarregar visualmente o artigo.
Com essa nova experiência, desenvolvedores conseguem compreender com mais rapidez:
- quais informações devem ser enviadas em uma requisição;
- como os campos estão organizados;
- quais valores são retornados pela API;
- quais objetos possuem estruturas internas;
- como arrays e dados aninhados devem ser interpretados.
Informações destacadas automaticamente
A documentação passa a identificar e destacar automaticamente informações importantes sobre cada campo, como:
- tipo do campo;
- indicação de campo obrigatório;
- tamanho máximo permitido;
- objetos aninhados;
- arrays;
- estruturas hierárquicas;
- opções de expansão dinâmica.
Na prática, isso torna a documentação de APIs mais intuitiva, clara e próxima da experiência encontrada em plataformas especializadas em documentação técnica.
O novo formato também pode reduzir o tempo necessário para entender requisições e respostas, ajudando os desenvolvedores durante a implementação e a manutenção de integrações.
Novos cards informativos para destacar conteúdos importantes
Os artigos da Base de Conhecimento agora podem utilizar novos cards informativos para destacar mensagens relevantes durante a leitura.
Com poucos atributos HTML, é possível criar caixas de destaque para diferentes tipos de conteúdo, como:
- informações importantes;
- observações;
- avisos;
- mensagens de sucesso;
- erros;
- limitações;
- recomendações de segurança;
- orientações adicionais.
Cada categoria recebe automaticamente uma identidade visual própria, com cores, ícones e formatação consistentes.
Esse recurso facilita a identificação de informações que exigem mais atenção e ajuda a evitar que orientações importantes fiquem perdidas em textos extensos.
Como os cards melhoram a experiência do usuário?
Os cards informativos permitem separar visualmente uma mensagem do restante do artigo.
Por exemplo, uma empresa pode utilizar um card de aviso para comunicar que determinada configuração exige permissão administrativa. Já um card de sucesso pode confirmar o resultado esperado após a conclusão de uma etapa.
Além de organizar o conteúdo, esses elementos ajudam o leitor a compreender mais rapidamente a importância de cada informação.
Blocos de código com destaque de sintaxe
A documentação técnica também ganhou novos recursos para a apresentação de exemplos de código.
Os blocos <pre> agora permitem definir a linguagem de programação por meio do atributo data-language. Ao identificar esse atributo, a Base de Conhecimento aplica automaticamente o destaque de sintaxe, também conhecido como syntax highlighting.
Esse recurso utiliza cores e formatações diferentes para destacar comandos, propriedades, variáveis, valores e outros elementos do código.
Como resultado, os exemplos tornam-se mais fáceis de ler, analisar e copiar.
Quais linguagens são suportadas?
Entre as linguagens e formatos que podem receber destaque de sintaxe estão:
- PHP;
- JavaScript;
- TypeScript;
- Node.js;
- Java;
- Python;
- Bash;
- Shell;
- SQL;
- HTML;
- XML;
- JSON;
- YAML;
- CSV;
- entre outras.
Essa variedade permite criar documentações completas para diferentes tipos de aplicações, integrações, bancos de dados e serviços.
Mais clareza para quem desenvolve integrações
O destaque de sintaxe aproxima a experiência da Base de Conhecimento da encontrada em grandes plataformas de documentação técnica.
Com códigos mais legíveis, os desenvolvedores conseguem identificar com mais facilidade:
- nomes de propriedades;
- valores esperados;
- comandos;
- estruturas JSON;
- consultas SQL;
- parâmetros de requisição;
- exemplos de resposta;
- possíveis erros de escrita.
Isso pode contribuir para uma implementação mais ágil e reduzir falhas causadas pela interpretação incorreta dos exemplos apresentados.
Carregamento inteligente e melhor desempenho
Além da melhoria visual, o carregamento das bibliotecas responsáveis pelo destaque de código acontece automaticamente, de acordo com as linguagens utilizadas em cada artigo.
Isso significa que a página carrega somente os recursos necessários para exibir o conteúdo publicado.
Dessa forma, é possível oferecer uma documentação técnica mais completa sem comprometer o desempenho e a velocidade da Base de Conhecimento.
Quais são os benefícios das novas atualizações?
As melhorias tornam a Base de Conhecimento mais adequada para conteúdos de suporte, treinamentos, manuais internos e documentações técnicas.
Entre os principais benefícios estão:
- leitura mais confortável em computadores e dispositivos móveis;
- organização mais clara de dados e informações;
- melhor apresentação de tabelas;
- documentação de APIs mais intuitiva;
- navegação simplificada por objetos e arrays;
- identificação rápida de avisos e informações importantes;
- exemplos de código mais legíveis;
- carregamento otimizado dos recursos técnicos;
- manutenção da identidade visual da empresa;
- melhor experiência de autoatendimento.
Uma Base de Conhecimento mais completa para empresas e desenvolvedores
Uma Base de Conhecimento bem estruturada ajuda clientes e colaboradores a encontrarem respostas com mais autonomia.
Com as novas atualizações, a TomTicket amplia as possibilidades de criação de conteúdos, atendendo tanto empresas que precisam publicar artigos de suporte quanto equipes que produzem documentações técnicas mais detalhadas.
As tabelas modernas facilitam a consulta de informações. Os cards informativos destacam orientações importantes. A documentação hierárquica organiza estruturas complexas de APIs. Já o destaque de sintaxe melhora a apresentação dos exemplos de código.
Tudo isso contribui para uma experiência de leitura mais clara, profissional e eficiente.
Perguntas frequentes sobre a atualização da Base de Conhecimento
As novas tabelas funcionam em dispositivos móveis?
Sim. As tabelas receberam ajustes de responsividade para melhorar a visualização e a navegação em celulares, tablets e telas menores.
As tabelas mantêm as cores personalizadas da empresa?
Sim. O novo formato continua respeitando as cores configuradas pela empresa, mantendo a identidade visual da Base de Conhecimento.
É possível documentar objetos e arrays de uma API?
Sim. A documentação permite criar estruturas hierárquicas para objetos e arrays. Esses elementos podem ser expandidos e recolhidos durante a leitura.
Quais informações podem ser exibidas nos campos de uma API?
A documentação pode destacar o tipo do campo, a obrigatoriedade, o tamanho máximo, os objetos aninhados, os arrays e outras informações da estrutura.
Para que servem os novos cards informativos?
Eles servem para destacar avisos, observações, informações importantes, mensagens de sucesso, erros, limitações e outras orientações relevantes.
A Base de Conhecimento possui destaque de sintaxe?
Sim. Os blocos de código podem identificar a linguagem utilizada e aplicar automaticamente o destaque de sintaxe.
Quais linguagens de programação são compatíveis?
A funcionalidade é compatível com linguagens e formatos como PHP, JavaScript, TypeScript, Node.js, Java, Python, Bash, Shell, SQL, HTML, XML, JSON, YAML e CSV, entre outros.
O destaque de código deixa a página mais pesada?
As bibliotecas são carregadas automaticamente conforme as linguagens utilizadas no artigo. Assim, somente os recursos necessários são adicionados à página, contribuindo para um carregamento mais eficiente.
Conheça a Base de Conhecimento da TomTicket
Com uma Base de Conhecimento organizada, sua empresa pode centralizar orientações, documentar processos, publicar tutoriais e facilitar o acesso a informações importantes.
As novas funcionalidades da TomTicket oferecem mais recursos para criar conteúdos modernos, responsivos e adequados às necessidades de clientes, equipes de atendimento e desenvolvedores.
