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:
- Matautique
- Rédacteur technique:
- Favori Kelvin
- 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é où les informations sont stockées, organisées, puis partagées. Lorsqu'elle est utilisée en externe, une base de connaissances est l'endroit où les utilisateurs peuvent accéder pour tout savoir 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 toutes les connaissances et toutes les informations de l'entreprise en interne. Bien que le contenu des bases de connaissances spécifiques varie en fonction de nombreux facteurs, le plus souvent, elles contiennent des informations sur la façon de commencer à utiliser des produits spécifiques, de tirer le meilleur parti des fonctionnalités avancées et de résoudre les problèmes ou problèmes courants. Le principal avantage de la création et de la présentation d'une base de connaissances à votre audience est que vous pouvez fournir des informations et des réponses détaillées, instantanées et à la demande aux membres de votre audience/aux utilisateurs/à la communauté, sans avoir à le faire individuellement.
La base de connaissances Mautic 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 dans Mautic) ou indirectement (par exemple, des stratégies marketing plus générales).
Au moment où nous écrivons ces lignes, la base de connaissances 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 d'avoir une expérience fluide lorsqu'ils utilisent Mautic. La navigation dans la base de connaissances Mautic était très instructive, mais nécessitait des tutoriels mis à jour et des guides pratiques pour en créer de nouveaux et pour correspondre à la version Mautic 3x.
Premières impressions lorsque je consulte la documentation existante Actuellement, la base de connaissances Mautic est disponible sur 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 l'amélioration que vous proposez-vous par rapport à un ou plusieurs domaines actuels auxquels j'aimerais contribuer ? L'amélioration proposée consistera à améliorer et à garantir l'efficacité, la cohérence et la tranquillité d'esprit de tous les utilisateurs finaux. Elle contiendra des tutoriels écrits, des guides d'utilisation et des bonnes pratiques, ainsi que les images associées. Il comprendra des instructions et des explications sur la façon d'utiliser chaque fonctionnalité du mautic, à jour, facile à parcourir et compréhensible.
Analyse
La base de connaissances Mautic a été écrite en fichier plat Grav CMS et utilise 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.
- Mettre à jour les tutoriels et les guides d'utilisation pour la version 3X de Mautic.
- Créer des ressources pour la nouvelle base de connaissances de la communauté mautique
- Rédigez une série de tutoriels et de guides pratiques qui aideront les utilisateurs de Mautic à configurer et utiliser l'application de manière plus efficace.
- Mettez à jour le tutoriel vidéo pour qu'il corresponde à la version Mautic 3X.
- Supprimez les images et les informations obsolètes.
- Réécrivez la base de connaissances pour qu'elle soit plus facile à comprendre.
- S'assurer de la bonne implémentation du guide de style ou du modèle de la documentation de la base de connaissances
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.
Engagement avec une communauté (1er août - 1er septembre)
- Mettre en place 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 d'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 travaillerais directement avec mes mentors pour :
- Passez en revue la base de connaissances.
- Mettre à jour les tutoriels et les guides d'utilisation pour la version 3X de Mautic.
- Créer des ressources pour la nouvelle base de connaissances de la communauté mautique
- Rédigez une série de tutoriels et de guides pratiques qui aideront les utilisateurs de Mautic à configurer et utiliser l'application de manière plus efficace.
- Mettez à jour le tutoriel vidéo pour qu'il corresponde à la version Mautic 3X.
- Supprimez les images et les informations obsolètes.
- Réécrivez la base de connaissances pour qu'elle soit plus facile à comprendre.
- S'assurer de la bonne implémentation du guide de style ou du modèle de la documentation de la base de connaissances.
- Prise en compte de la cadence de publication, car l'équipe de développement serait occupée par les sorties 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édige et envoie un rapport sur mon expérience de participant à Season of Docs.