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:
- Favorar Kelvin
- Nome do projeto:
- Knowledgebase
- Duração do projeto:
- Duração padrão (três meses)
Project description
Resumo
A base de conhecimento é um repositório centralizado em que as informações são armazenadas, organizadas e compartilhadas. Quando usada externamente, uma base de conhecimento é onde os usuários podem aprender tudo o que precisam saber sobre os produtos ou serviços, a organização e o setor de uma empresa. Uma base de conhecimento interna, por outro lado, geralmente é utilizada para permitir que a comunidade/usuários colaborem e distribuam todo o conhecimento e as informações da empresa internamente. Embora o conteúdo das bases de conhecimento varie de acordo com vários fatores, a maioria delas inclui informações sobre como começar a usar produtos específicos, aproveitar mais os recursos avançados e superar problemas comuns. O principal benefício de criar e apresentar uma base de conhecimento ao público-alvo é que você pode fornecer informações detalhadas, instantâneas e sob demanda, além de respostas aos membros do público-alvo/usuários/comunidade sem precisar fazer isso individualmente.
A base de conhecimento do Mautic é um repositório central de tutoriais, guias de instruções e práticas recomendadas sobre temas relacionados ao Mautic, seja diretamente (por exemplo, como fazer coisas no Mautic) ou indiretamente (por exemplo, estratégias de marketing mais gerais).
No momento em que este artigo foi escrito, a base de conhecimento do Mautic era bastante nova e incompleta. A comunidade do Mautic quer usar esse projeto para melhorar a forma de fornecer informações detalhadas e sob demanda na documentação do usuário e permitir que os usuários finais tenham uma experiência perfeita ao usar o Mautic. A base de conhecimento da Mautic foi bastante informativa, mas precisava de tutoriais atualizados e guias de instruções, além da criação de novos tutoriais para corresponder à versão 3x da Mautic.
Minhas primeiras impressões ao ler a documentação atual. Atualmente, a base de conhecimento do Mautic está disponível em https://kb.mautic.org/. Alguns dos tutoriais, guias de instruções e tópicos de práticas recomendadas na documentação não estão atualizados e são escassos ou incompletos, além de não abordarem informações sobre a versão atual do Mautic.
Por que a melhoria proposta é melhor do que a atual/áreas em que gostaria de contribuir? A melhoria proposta será para melhorar e garantir a eficiência, a consistência e a tranquilidade de qualquer usuário final. Ele conterá tutoriais escritos, guias de instruções, práticas recomendadas e suas imagens associadas, além de instruções e explicações sobre como usar cada recurso do mauto, atualizado, fácil de navegar e compreensível.
Análise
A base de conhecimento do Mautic foi escrita no CMS de arquivos planos do Grav e no tema KLB4. Pesquisei muito sobre maneiras de melhorar a documentação da base de conhecimento.
Metas do projeto
- Revise a base de conhecimento.
- Atualizamos os tutoriais e guias de instruções para a versão 3x do Mautic.
- Criar recursos para a base de conhecimento da comunidade Mautic recém-criada
- Escreva uma série de tutoriais e guias para ajudar os usuários do Mautic a configurar, configurar e usar o aplicativo de maneira mais eficiente.
- Atualize o tutorial em vídeo para se ajustar à versão 3x do Mautic.
- Remova imagens e informações obsoletas.
- Reescreva a base de conhecimento para facilitar a compreensão.
- Garantir a implementação adequada do guia/padrão de estilo da documentação da base de conhecimento
Cronograma
Antes de 1º de agosto
- Continuar contribuindo com a organização.
- Conheça melhor a documentação da base de conhecimento e a versão atual do Mautic.
- Aprender novas técnicas e habilidades técnicas de escrita que serão úteis na implementação do projeto.
Interação com a comunidade (1o de agosto a 1o de setembro)
- Configure um canal de comunicação e um horário (devido à diferença de horário)
- Refinar minhas metas e definir as expectativas em ambos os lados
- Saiba mais sobre a comunidade e o produto
- Discutir a estrutura de documentação proposta com os mentores e outros membros da organização.
- Finalize os recursos propostos e outras modificações que precisam ser feitas na documentação atual.
Período de documentação
- Semana 1 (2 a 22 de novembro)
- Durante esses períodos, eu trabalharia diretamente com meus mentores para :
- Consulte a base de conhecimento.
- Atualizamos os tutoriais e guias de instruções para a versão 3x do Mautic.
- Criar recursos para a base de conhecimento da comunidade Mautic recém-criada
- Escreva uma série de tutoriais e guias para ajudar os usuários do Mautic a configurar, configurar e usar o aplicativo de maneira mais eficiente.
- Atualize o tutorial em vídeo para se ajustar à versão 3x do Mautic.
- Remova imagens e informações obsoletas.
- Reescreva a base de conhecimento para facilitar a compreensão.
- Garantir a implementação adequada do guia de estilo/padrão da documentação da base de conhecimento.
- Levando em consideração a cadência de lançamento, já que a equipe de desenvolvimento estaria ocupada com lançamentos de recursos menores
Avaliação do projeto (25 a 29 de novembro de 2019)
- Enviar um relatório e uma avaliação do projeto pelos meus mentores
- Escrever e enviar um relatório sobre minha experiência como participante da Temporada de documentos.