Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Masculin
- Rédacteur technique:
- Kelvin préféré
- Nom du projet:
- Base de connaissances
- Durée du projet:
- Durée standard (3 mois)
Project description
Abstraite
Une base de connaissances est un référentiel centralisé dans lequel les informations sont stockées, organisées et partagées. Lorsqu'elle est utilisée en externe, une base de connaissances permet aux utilisateurs de se renseigner sur tout ce dont ils ont besoin sur les produits ou services d'une entreprise, son organisation et son secteur d'activité. Une base de connaissances interne, en revanche, est généralement utilisée pour permettre à la communauté et aux utilisateurs de collaborer et de diffuser en interne l'ensemble des connaissances et des informations de l'entreprise. Bien que le contenu des bases de connaissances spécifiques varie en fonction de nombreux facteurs, la plupart du temps, ils contiennent des informations permettant de commencer à utiliser des produits spécifiques, de tirer le meilleur parti des fonctionnalités avancées et de résoudre des problèmes ou problèmes courants. L'avantage principal de la création et de la présentation d'une base de connaissances à votre audience est qu'elle vous permet de fournir des informations et des réponses détaillées, instantanées et à la demande aux membres de votre audience, aux utilisateurs ou à la communauté, sans avoir à le faire individuellement.
Mautic Knowledge est un référentiel central contenant des tutoriels, des guides d'utilisation et des bonnes pratiques sur des sujets en rapport avec Mautic, que ce soit directement (par exemple, comment faire des choses avec Mautic) ou indirectement (par exemple, des stratégies marketing plus générales).
Au moment de la rédaction de ce document, la base de connaissances de Mautic est assez nouvelle et incomplète. La communauté Mautic souhaite utiliser ce projet pour améliorer sa façon de fournir des informations détaillées et à la demande à la documentation utilisateur, afin de permettre aux utilisateurs finaux de bénéficier d'une expérience fluide lorsqu'ils utilisent Mautic. La visite de la base de connaissances Mautic était assez instructive, mais les tutoriels et les guides pratiques devaient être mis à jour pour en créer d'autres et correspondre à la version Mautic 3X.
Premières impressions en consultant la documentation existante La base de connaissances Mautic est actuellement disponible à l'adresse https://kb.mautic.org/. Certains tutoriels, guides d'utilisation et bonnes pratiques inclus dans la documentation ne sont pas à jour, sont creux ou incomplets, et ne contiennent pas non plus d'informations sur la version actuelle du mautique.
Pourquoi votre proposition d'amélioration concerne-t-elle un ou plusieurs domaines auxquels je souhaiterais contribuer ? L'amélioration proposée aura pour but d'améliorer et d'assurer l'efficacité, la cohérence et la tranquillité d'esprit de tous les utilisateurs finaux. Elle contiendra des tutoriels écrits, des guides d'utilisation, des bonnes pratiques et les images associées, ainsi que des instructions et des explications sur la façon d'utiliser chaque fonctionnalité du mautique, à jour, facile à parcourir et compréhensible.
Analyse
La base de connaissances Mautic a été écrite en fichier plat Grav du CMS et le thème KLB4. J'ai beaucoup recherché des moyens d'améliorer la documentation de la base de connaissances
Objectifs du projet
- Passez en revue la base de connaissances.
- Mettez à jour les tutoriels et les guides d'utilisation de la version Mautic 3x.
- Créer des ressources pour la nouvelle base de connaissances sur la communauté maute
- Rédigez une série de tutoriels et de guides pratiques qui aideront les utilisateurs de Mautic à configurer et utiliser l'application plus efficacement.
- Mettez à jour le tutoriel vidéo pour qu'il s'adapte à la version Mautic 3x.
- Supprimez les images et les informations obsolètes.
- Réécrivez la base de connaissances pour la rendre plus facile à comprendre.
- S'assurer que le guide de style ou le modèle de la documentation de la base de connaissances est correctement implémenté
Chronologie
Avant le 1er août
- Continuer à contribuer à l'organisation.
- Familiarisez-vous avec la documentation de la base de connaissances et la version actuelle de Mautic.
- Apprendre de nouvelles techniques et compétences en rédaction technique qui seront utiles lors de la mise en œuvre du projet.
Liens entre communautés (1er août-1er septembre)
- Définir un canal de communication et un horaire (en raison du décalage horaire)
- Affiner mes objectifs et définir des attentes des deux côtés
- En savoir plus sur la communauté et le produit
- Discuter de la structure de documentation proposée avec les mentors et les autres membres de l'organisation.
- Finaliser les fonctionnalités proposées et les autres modifications à apporter à la documentation existante
Période de documentation
- Semaine 1 (2 septembre - 22 novembre)
- Durant ces périodes, je travaille directement avec mes mentors pour :
- Passez en revue la base de connaissances.
- Mettez à jour les tutoriels et les guides d'utilisation de la version Mautic 3x.
- Créer des ressources pour la nouvelle base de connaissances sur la communauté maute
- Rédigez une série de tutoriels et de guides pratiques qui aideront les utilisateurs de Mautic à configurer et utiliser l'application plus efficacement.
- Mettez à jour le tutoriel vidéo pour qu'il s'adapte à la version Mautic 3x.
- Supprimez les images et les informations obsolètes.
- Réécrivez la base de connaissances pour la rendre plus facile à comprendre.
- S'assurer que le guide de style ou le modèle de la documentation de la base de connaissances sont correctement implémentés.
- Prise en compte de la fréquence de publication, car l'équipe de développement serait occupée par les publications de fonctionnalités mineures.
Évaluation du projet (du 25 au 29 novembre 2019)
- Envoyer un rapport de projet et une évaluation par mes mentors
- Rédiger et envoyer un rapport sur mon expérience en tant que participante à la saison des documents.