Nomear elementos em um projeto, seja em programação ou na construção de bots, é essencial para a manutenção e a clareza do projeto. Aqui estão algumas práticas recomendadas e estruturadas para nomear blocos no Builder, inspiradas nos princípios do design tokens.
A Importância da Nomenclatura
Nomear elementos de um projeto vai além de uma tarefa puramente criativa; é uma prática crucial que impacta diretamente na facilidade de manutenção e na compreensão do projeto todo. Um nome bem escolhido pode poupar tempo e esforço quando se trata de atualizações ou documentação.
Desafios na Nomenclatura
- Limites de caracteres: até 23/03/2024, o limite para nomes de blocos é de 50 caracteres, incluindo espaços.
- Prazos apertados: projetos frequentemente operam sob prazos restritos, tornando a tarefa de nomeação menos prioritária.
Aplicação de Design Tokens para Nomenclatura
Embora o foco principal do design tokens esteja na comunicação entre designers e desenvolvedores e na escalabilidade de sistemas de design, os princípios podem ser adaptados para a nomenclatura de blocos no builder.
Estrutura
A estrutura de nomenclatura deve ser pensada para maximizar a clareza dentro do limite de 50 caracteres. Uma abordagem é utilizar uma combinação de categorias que representem skill, id, ação, significado e tipo. Para economizar caracteres, o tipo pode ser representado por uma tag no builder.
Ações
Defina ações com base no padrão de responsabilidade única para cada bloco. Adapte às necessidades e preferências da sua equipe, escolhendo verbos que melhor descrevem as funções dos blocos.
Tipos
-
Conteúdo: Blocos que exibem informações sem esperar uma resposta do usuário.
-
Diferenciação de Tipos:
- Texto é o tipo mais básico e pode coexistir com outros tipos, como vídeo ou PDF.
- Para maior clareza, é recomendável usar [vídeo], [pdf], [áudio] para definir o tipo de mídia presente no bloco.
- Alternativamente, pode-se usar categorias mais amplas como [conteúdo] ou dividir em [texto] e [anexos].
Manutenção da estrutura
Para facilitar a manutenção futura, evite misturar diferentes tipos de mídia no mesmo bloco, como vídeo, PDF e áudio. Isso mantém a estrutura organizada e simplifica a localização e atualização de blocos específicos.
A adoção de uma estratégia de nomenclatura clara e consistente, inspirada no design tokens, pode melhorar a manutenção e escalabilidade de projetos no Builder. Ao estabelecer e seguir essas práticas, equipes podem economizar tempo e evitar complicações na gestão de seus bots.
Referências
Naming Tokens in Design Systems por Nathan Curtis
Blip Academy
*texto corrigido e editado por Inteligência Artificial.
