Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Mautic
- Rédacteur technique:
- Afficher en Kelvin
- Nom du projet:
- Knowledgebase
- Durée du projet:
- Durée standard (trois mois)
Project description
Extrait
Une base de connaissances est un dépôt centralisé où les informations sont stockées, organisées, puis partagées. Lorsqu'elle est utilisée en externe, une base de connaissances permet aux utilisateurs de trouver toutes les informations dont ils ont besoin sur les produits ou services, l'organisation et le secteur d'une entreprise. En revanche, une base de connaissances interne permet généralement à la communauté/aux utilisateurs de collaborer et de distribuer en interne l'ensemble des connaissances et des informations de l'entreprise. Bien que le contenu d'une base de connaissances spécifique varie en fonction de nombreux facteurs, il contient généralement des informations sur la manière de commencer à utiliser des produits spécifiques, de mieux exploiter les fonctionnalités avancées et de résoudre les problèmes ou problèmes courants. L'avantage principal de créer et de présenter 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 à vos membres/utilisateurs/communautés, sans avoir à le faire individuellement.
Mautic Knowledgebase est un référentiel central pour des tutoriels, des guides d'utilisation et des bonnes pratiques sur des sujets liés à Mautic, que ce soit directement (par exemple, comment faire quelque chose dans Mautic) ou indirectement (par exemple, des stratégies marketing plus générales).
Au moment de la rédaction de cet article, la base de connaissances Mautic est assez récente et incomplète. La communauté Mautic souhaite utiliser ce projet pour améliorer la façon dont elle fournit des informations détaillées et à la demande dans la documentation utilisateur afin de permettre aux utilisateurs finaux de bénéficier d'une expérience fluide lorsqu'ils utilisent Mautic. Parcourir la base de connaissances Mautic a été assez instructif, mais nécessitait des tutoriels mis à jour et des guides d'utilisation, ainsi que la création de nouveaux guides et la mise en correspondance de la version Mautic 3x.
Mes premières impressions en parcourant la documentation existante La base de connaissances Mautic est actuellement disponible à l'adresse https://kb.mautic.org/. Certains des tutoriels, guides et bonnes pratiques de la documentation ne sont pas à jour, sont peu nombreux ou incomplets, et ne fournissent pas d'informations sur la version actuelle de Mautic.
Pourquoi votre proposition d'amélioration est-elle meilleure que l'actuelle/les domaines dans lesquels j'aimerais contribuer ? L'amélioration proposée consiste à améliorer et à garantir l'efficacité, la cohérence et la tranquillité d'esprit de tout utilisateur final. Il contiendra des tutoriels et des guides pratiques écrits, ainsi que des bonnes pratiques et les images associées. Il comprendra des instructions et des explications sur l'utilisation de chaque fonctionnalité de Mautic, et sera à jour, facile à parcourir et compréhensible.
Analyse
La base de connaissances Mautic a été écrite dans le CMS de fichiers plats Grav et le thème KLB4. J'ai beaucoup étudié les moyens d'améliorer la documentation de la base de connaissances.
Objectifs du projet
- Examinez la base de connaissances.
- Mise à jour des tutoriels et des guides d'utilisation pour qu'ils correspondent à la version Mautic 3x.
- Créer des ressources pour la nouvelle base de connaissances de la communauté Mautic
- Rédigez une série de tutoriels et de guides qui aideront les utilisateurs de Mautic à configurer, configurer et utiliser plus efficacement l'application.
- Mise à jour du tutoriel vidéo pour qu'il corresponde à la version Mautic 3x.
- Supprimez les images et informations obsolètes.
- Réécrivez la base de connaissances pour la rendre plus facile à comprendre.
- Assurez-vous que le guide de style/le modèle de la documentation de la base de connaissances est correctement implémenté.
Chronologie
Avant le 1er août
- Continuez à apporter des contributions à l'organisation.
- Familiarisez-vous avec la documentation de la base de connaissances et la version actuelle de Mautic.
- Acquérir de nouvelles techniques et compétences techniques en matière de rédaction qui seront utiles lors de la mise en œuvre du projet.
Liens entre les communautés (du 1er août au 1er septembre)
- Configurer 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)
- Pendant ces périodes, je travaillerai directement avec mes mentors pour :
- Examinez la base de connaissances.
- Mise à jour des tutoriels et des guides d'utilisation pour qu'ils correspondent à la version Mautic 3x.
- Créer des ressources pour la nouvelle base de connaissances de la communauté Mautic
- Rédigez une série de tutoriels et de guides qui aideront les utilisateurs de Mautic à configurer, configurer et utiliser plus efficacement l'application.
- Mise à jour du tutoriel vidéo pour qu'il corresponde à la version Mautic 3x.
- Supprimez les images et informations obsolètes.
- Réécrivez la base de connaissances pour la rendre plus facile à comprendre.
- Assurez-vous que le guide de style ou le modèle de la documentation de la base de connaissances sont correctement mis en œuvre.
- En tenant compte de la cadence de publication, car l'équipe de développement sera occupée par les versions mineures
Évaluation du projet (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 participant à la saison Docs