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:
- Favorecer Kelvin
- Nome do projeto:
- Base de conhecimento
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Com abstração
Uma base de conhecimento é um repositório centralizado em que as informações são armazenadas, organizadas e compartilhadas. Quando usada externamente, a base de conhecimento é onde os usuários podem aprender tudo que precisam saber sobre os produtos ou serviços de uma empresa, organização e setor. Uma base de conhecimento interna, por outro lado, é normalmente utilizada como uma forma de permitir que a comunidade/usuários colaborem e distribuam internamente todo o conhecimento e as informações da empresa. Embora o conteúdo das bases de conhecimento específicas varie de acordo com vários fatores, a maioria geralmente inclui informações sobre como começar a usar produtos específicos, aproveitar melhor os recursos avançados e superar problemas ou problemas comuns. O principal benefício de criar e apresentar uma base de conhecimento ao seu público é que isso permite que você forneça informações detalhadas, instantâneas e sob demanda, além de respostas aos membros do público/usuários/à comunidade sem precisar fazer isso individualmente.
O Mautic Knowledgebase é um repositório central de tutoriais, guias de instruções e práticas recomendadas sobre temas relacionados ao Mautic, seja de forma direta (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 canal Mautic é nova e incompleta. A comunidade quer usar o projeto para melhorar a maneira de fornecer informações detalhadas e sob demanda à documentação do usuário, permitindo que os usuários finais tenham uma experiência perfeita ao usar o app. Analisar a base de conhecimento do Mautic foi bastante informativo, mas precisou de tutoriais atualizados e guias de instruções para criar novos vídeos e corresponder à versão do Mautic 3x.
Minhas primeiras impressões ao analisar a documentação Atualmente, a base de conhecimento do Mautic está disponível: https://kb.mautic.org/ (em inglês). 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 esparsos ou incompletos. Além disso, eles não abrangem informações sobre a versão atual do mautic.
Por que sua proposta de melhoria é relacionada às áreas atuais com as quais eu gostaria de contribuir? A melhoria proposta será melhorar e garantir eficiência, consistência e tranquilidade para qualquer usuário final. Ele conterá tutoriais por escrito e guias de instruções, além de práticas recomendadas e suas imagens associadas, além de incluir instruções e explicações sobre como usar cada recurso do mautic, atualizado, fácil de navegar e compreensível.
Análise
A base de conhecimento do Mautic foi escrita no CMS de arquivo simples 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.
- Atualize os tutoriais e os guias de instruções para se adequar à versão do Mautic 3x.
- Crie recursos para a base de conhecimento da comunidade Mautic recém-criada
- Escreva uma série de tutoriais e guias explicativos para ajudar os usuários do Mautic a serem mais eficientes ao configurar, configurar e usar o aplicativo.
- Atualize o tutorial em vídeo para se ajustar à versão do Mautic 3x.
- Remova imagens e informações obsoletas.
- Reescreva a base de conhecimento para facilitar o entendimento.
- Garantir a implementação adequada do guia de estilo/padrão da documentação da base de conhecimento
Cronograma
Antes de 1o de agosto
- Continue fazendo contribuições à organização.
- Conhecer 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 para a implementação do projeto.
Vínculo comunitário (1o de agosto a 1o de setembro)
- Estabelecer um canal de comunicação e um horário (devido à diferença de horário)
- Refinar minhas metas e definir 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.
- Finalizar os recursos propostos e outras modificações que precisam ser feitas na documentação existente.
Período de documentação
- Semana 1 (de 2 de setembro a 22 de novembro)
- Durante esses períodos, trabalharia diretamente com meus mentores para :
- Revise a base de conhecimento.
- Atualize os tutoriais e os guias de instruções para se adequar à versão do Mautic 3x.
- Crie recursos para a base de conhecimento da comunidade Mautic recém-criada
- Escreva uma série de tutoriais e guias explicativos para ajudar os usuários do Mautic a serem mais eficientes ao configurar, configurar e usar o aplicativo.
- Atualize o tutorial em vídeo para se ajustar à versão do Mautic 3x.
- Remova imagens e informações obsoletas.
- Reescreva a base de conhecimento para facilitar o entendimento.
- Garantir a implementação adequada do guia de estilo/padrão da documentação da base de conhecimento.
- Considerando a cadência de lançamento, porque a equipe de desenvolvimento estaria ocupada com lançamentos de recursos menores.
Avaliação de projetos (25 a 29 de novembro de 2019)
- Enviar um relatório de projeto e uma avaliação com meus mentores
- Escrever e enviar um relatório sobre minha experiência como participante da temporada de Documentos Google.