Projeto Mautic

Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.

Resumo do projeto

Organização de código aberto:

Mautic

(em inglês)

Redator técnico:

Swati Thacker

Nome do projeto:

Revise e atualize a documentação do usuário final para o Mautic

Duração do projeto:

Duração padrão (três meses)

Project description

Minhas primeiras impressões ao ler a documentação atual:

Atualmente, a documentação é longa, redundante em muitos lugares, incompleta e desorganizada, o que pode dificultar a busca de informações pelos usuários.

Como usuário iniciante, não entendi como os diferentes elementos do Mautic, como campanhas, recursos, mensagens, categorias etc., se encaixam para resolver uma necessidade comercial. Proponho um tópico conceitual de alto nível que descreva cada elemento do Mautic em duas ou três linhas. Esse tópico pode, por sua vez, vincular aos vários tópicos de tarefas detalhadas para cada um desses elementos.

O guia de contribuição pode ser expandido para incluir mais informações, como como abrir um problema, sugerir novos conteúdos/ideias, informar bugs/problemas/vulnerabilidades de segurança etc., fornecendo links para fóruns, canais do Slack e repositórios do Git. Além disso, o guia de estilo precisa ser expandido para incluir convenções tipográficas padrão, diretrizes para imagens, tabelas etc.

Além disso, há muita informação incompleta nos e-mails e campanhas, além de informações antigas/desatualizadas que precisam ser atualizadas.

Área em que gostaria de contribuir:

Durante as discussões nos canais do Slack em que os usuários interagem diretamente com a comunidade do Mautic, percebi que campanhas e e-mails são elementos cruciais do Mautic. Ao usar o Mautibox para a versão 3, testei a documentação sobre campanhas e descobri que ela precisa de uma grande reformulação. Confira alguns problemas que encontrei e minha proposta para cada um deles:

• Um usuário da Mautic pode escolher entre uma variedade de ações, decisões e condições ao criar uma campanha. A documentação está faltando para muitas ações e decisões, e quase não há documentação para condições de campanha. Precisamos identificar e adicionar as informações que faltam ao documento do usuário final.
• As campanhas podem ser simples ou altamente complexas. A documentação atual não agrega muito valor aos usuários que estão criando campanhas pela primeira vez. Proponho a identificação de alguns casos de uso (simples e complexos) e a criação de fluxos de trabalho de amostra (na forma de tutoriais passo a passo, seja na forma de tutoriais passo a passo ou tópicos no guia do usuário final ou em vídeos de orientação) aos quais um usuário iniciante pode consultar antes de começar a criar suas próprias campanhas.
• As informações precisam ser apresentadas de maneira mais organizada e ordenada nesta seção. A abordagem baseada em tarefas e conceitos precisa ser seguida para aumentar a usabilidade. Os tópicos podem usar tabelas para apresentar informações sobre ações, decisões e condições. O tópico "Como usar gatilhos de data" parece um pouco fora do lugar. Ele pode ser aninhado em "Condições".

Além das campanhas, também testei a documentação de e-mails na interface. Minha proposta é a seguinte:

• O conteúdo dinâmico para e-mails está disponível para modelos de e-mail de código personalizado (para e-mails de modelos e segmentos), mas atualmente não há documentação sobre ele. Adicione detalhes sobre o que é o conteúdo dinâmico e como configurá-lo, além de alguns exemplos.
• Adicionar um tema separado para e-mails de monitoramento. Isso pode incluir informações sobre como usar os widgets de e-mail disponíveis no painel e como eles podem ser usados para acompanhar métricas e atividades relacionadas a e-mails. Além disso, mova as informações sobre o rastreamento de e-mails para aqui.
• A documentação não deixa claro que as respostas de contato, o gerenciamento de rejeições e o proprietário do remetente são configurações globais que podem ser definidas em "Configurações de e-mail". Todas as configurações de e-mail devem estar em um tópico abrangente. Além disso, muitas outras configurações de e-mail, como regras de frequência padrão e configurações de cancelamento de inscrição, não são documentadas. Mencione quais configurações são obrigatórias ou opcionais.
• Na página de gerenciamento de rejeições, remova todas as informações sobre Webhooks e coloque-as em um tópico separado. Podemos fornecer um link para esse tópico aqui.

Além disso: - O tópico "Painel" tem informações incompletas sobre os widgets disponíveis. Essas informações são importantes e precisam ser adicionadas para ajudar os usuários a analisar e monitorar os recursos do Mautic.

Toda a documentação precisa ser analisada para identificar lacunas. Precisamos reformular o documento para torná-lo mais acessível aos usuários.

Como espero que meu conhecimento/experiência seja benéfico para este projeto?

Depois de trabalhar em vários problemas na documentação do Mautic, incluindo a adição de suporte à versão mais recente do Mautic 3.0 no último mês, consegui me familiarizar com a estrutura da documentação do usuário final e também identificar as lacunas na documentação. Passei um tempo pesquisando a documentação de outras ferramentas de automação de marketing e comparando-a com a documentação do Mautic para usuários finais para entender como podemos preencher essas lacunas na nossa documentação. Minha familiaridade com a linguagem HTML, com as ferramentas de código aberto e com processos é uma vantagem adicional. Atualmente, estou realizando um curso de pesquisa de experiência do usuário e posso aplicar os princípios para criar documentação mais orientada ao usuário. Além disso, com minha experiência em arquitetura da informação, vou poder organizar o conteúdo e propor ideias para alinhar nossa documentação às metas do usuário. Além disso, tenho um talento para expandir meu conhecimento em novos domínios técnicos. Com 10 anos de experiência em redação técnica e minha experiência anterior no GSOD de concluir um projeto para uma organização em um domínio técnico completamente novo para mim, tenho certeza de que vou conseguir contribuir para a documentação do Mautic.