Projeto Mautic

Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.

Resumo do projeto

Organização de código aberto:

Mautic

Redator técnico:

Swati Thacker

Nome do projeto:

Revisar e atualizar a documentação do usuário final do Mautic

Duração do projeto:

Duração padrão (3 meses)

Project description

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

Atualmente, a documentação é longa, redundante em muitos lugares, incompleta e desordenada, o que pode dificultar que os usuários encontrem as informações que procuram.

Como usuário iniciante, não conseguia entender como os diferentes elementos do Mautic, como campanhas, recursos, mensagens, categorias etc., se encaixam para atender a uma necessidade comercial. Proponho um tópico conceitual de alto nível que descreva cada elemento Mautic em duas ou três linhas. Esse tópico pode, por sua vez, vincular a 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, por exemplo, como abrir um problema, sugerir novos conteúdos/ideias, relatar bugs/problemas/vulnerabilidades de segurança etc., fornecendo links para fóruns, canais do Slack e repositórios Git. Além disso, o guia de estilo precisa ser expandido para adicionar convenções tipográficas padrão, diretrizes para imagens, tabelas etc.

Além disso, há muitas informações incompletas em e-mails e campanhas, além de informações antigas/desatualizadas que precisam ser atualizadas.

A área com a qual eu gostaria de contribuir:

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

• Um usuário do Mautic pode escolher entre várias 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 as condições da campanha. Precisamos identificar e adicionar as informações que estão faltando 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 identificar alguns casos de uso (simples e complexos) e criar amostras de fluxos de trabalho (na forma de tutoriais passo a passo, tópicos no guia do usuário final ou vídeos passo a passo) aos quais um usuário iniciante pode consultar antes de começar a criar suas próprias campanhas.
• Nesta seção, é necessário apresentar as informações de maneira mais organizada e ordenada. 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 acionadores de data" parece um pouco deslocado. Ele pode ser aninhado em "Condições".

Além das campanhas, também testei a documentação de e-mails na interface. Veja no que eu proponho trabalhar:

• O conteúdo dinâmico para e-mails está disponível para modelos de e-mail com código personalizado (para e-mails de modelos e segmentos), mas atualmente não há documentação para isso. Adicione detalhes sobre o que o conteúdo dinâmico faz e como configurá-lo, além de alguns exemplos.
• Adicione um tópico separado para e-mails do Monitoring. Isso pode incluir informações sobre como usar os widgets de e-mail disponíveis no painel de controle e como eles podem ser usados para acompanhar métricas e atividades relacionadas ao e-mail. Além disso, mova informações sobre e-mails de rastreamento para cá.
• A documentação não deixa claro que respostas de contatos, gerenciamento de rejeições e correspondência com proprietário são configurações globais que podem ser definidas em Configurações de e-mail. Todas as configurações de e-mail devem estar relacionadas a 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 "Gerenciamento de rejeições", remova todas as informações sobre webhooks e coloque-as em um tópico separado para "Webhooks". Então podemos fornecer um link para o 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, porque ajudam os usuários a analisar e monitorar os recursos do Mautic.

Toda a documentação precisa ser contrariada para identificar lacunas. Precisamos reformular o documento para que ele seja mais acessível para nossos usuários.

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

Depois de resolver vários problemas na documentação do Mautic, incluindo a adição de suporte à versão mais recente do app, que foi lançada no último mês, pude me familiarizar com a estrutura da documentação do usuário final e identificar as lacunas na documentação. Dediquei tempo pesquisando a documentação de outras ferramentas de automação de marketing e comparando com a documentação do usuário final do Mautic 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. No momento, estou fazendo um curso sobre pesquisa de experiência do usuário e posso aplicar os princípios para criar uma documentação mais orientada ao usuário. Além disso, com minha experiência em arquitetura da informação, vou conseguir organizar conteúdos e propor ideias para alinhar nossa documentação aos objetivos do usuário. Além disso, tenho o dom de ampliar meu conhecimento de novos domínios técnicos. Com 10 anos de experiência técnica de escrita e minha experiência anterior com GSOD na conclusão de um projeto para uma organização em um domínio técnico que era completamente nova para mim, tenho certeza de que vou fazer jus à minha contribuição para a documentação do Mautic.