Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Mautic
- Redactor técnico:
- Priorizar a Kelvin
- Nombre del proyecto:
- Knowledgebase
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Resumen
Una base de conocimiento es un repositorio centralizado donde la información se almacena, organiza y, luego, se comparte. Cuando se usa de forma externa, una base de conocimiento es el lugar al que los usuarios pueden acudir para obtener toda la información que necesiten sobre los productos o servicios, la organización y la industria de una empresa. Por otro lado, una base de conocimiento interna suele utilizarse como una forma para permitir que la comunidad y los usuarios colaboren y distribuyan todo el conocimiento y la información de la empresa de forma interna. Si bien el contenido de las bases de conocimiento específicas varía según numerosos factores, por lo general, incluye información sobre cómo comenzar a usar productos específicos, aprovechar más las funciones avanzadas y superar problemas o dificultades comunes. El beneficio principal de crear y presentar una base de conocimiento a tu público es que te permite proporcionar información detallada, instantánea y a pedido, y respuestas a los miembros, usuarios o comunidad de tu público sin necesidad de hacerlo de forma individual.
La base de conocimiento de Mautic es un repositorio central de instructivos, guías prácticas y prácticas recomendadas sobre temas relacionados con Mautic, ya sea de manera directa (p.ej., cómo hacer actividades en Mautic) o indirectamente (p.ej., estrategias de marketing más generales).
En el momento de escribir este artículo, la base de conocimiento de Mautic es bastante nueva y está incompleta. La comunidad de Mautic quiere usar este proyecto para mejorar su forma de proporcionar información detallada y a pedido a la documentación del usuario para permitir que los usuarios finales tengan una experiencia fluida cuando usen Mautic. Revisar la base de conocimiento de Mautic fue bastante informativo, pero se necesitaban instructivos y guías actualizados, así como la creación de nuevos, además de que debían coincidir con la versión 3x de Mautic.
Mis primeras impresiones cuando revisé la documentación existente: Actualmente, la base de conocimiento de Mautic está disponible en https://kb.mautic.org/. Algunos de los instructivos, las guías prácticas y los temas de prácticas recomendadas de la documentación no están actualizados, son escasos o incompletos, y tampoco incluyen información sobre la versión actual de Mautic.
¿Por qué propones una mejora con respecto a la actual o a las áreas en las que me gustaría contribuir? La mejora propuesta será mejorar y garantizar la eficiencia, la coherencia y la tranquilidad para cualquier usuario final. Contendrá tutoriales escritos y guías prácticas y mejores prácticas y sus imágenes asociadas, incluirá instrucciones y explicaciones sobre cómo utilizar cada característica del mautic, actualizado, fácil de navegar y comprensible.
Análisis
La base de conocimiento de Mautic se escribió en el CMS de archivos planos Grav y el tema KLB4. Investigué mucho sobre cómo mejorar la documentación de la base de conocimiento.
Objetivos del proyecto
- Revisa la base de conocimiento.
- Se actualizaron los instructivos y las guías para que se ajusten a la versión 3x de Mautic.
- Crea recursos para la base de conocimiento recién creada de la comunidad de Mautic
- Escribe una serie de instructivos y guías que ayuden a los usuarios de Mautic a ser más eficaces en la configuración y el uso de la aplicación.
- Se actualizó el instructivo en video para que se ajuste a la versión 3x de Mautic.
- Quita las imágenes y la información obsoletas.
- Vuelve a escribir la base de conocimiento para que sea más fácil de entender.
- Garantizar la implementación adecuada de la guía de estilo o el patrón de la documentación de la base de conocimiento
Cronograma
Antes del 1 de agosto
- Seguir realizando contribuciones a la organización
- Familiarízate con la documentación de la base de conocimiento y la versión actual de Mautic.
- Aprender nuevas técnicas y habilidades de redacción técnica que te serán útiles durante la implementación del proyecto
Vinculación comunitaria (del 1 de agosto al 1 de septiembre)
- Configura un canal de comunicación y una hora (debido a la diferencia horaria)
- Definir mejor mis objetivos y establecer expectativas para ambas partes
- Más información sobre la comunidad y el producto
- Analizar la estructura de documentación propuesta con los mentores y otros miembros de la organización.
- Finaliza las funciones propuestas y otras modificaciones que se deben realizar en la documentación existente.
Período de documentación
- Semana 1 (del 2 de septiembre al 22 de noviembre)
- Durante estos períodos, trabajaría directamente con mis mentores para hacer lo siguiente :
- Revisa la base de conocimiento.
- Se actualizaron los instructivos y las guías para que se ajusten a la versión 3x de Mautic.
- Crea recursos para la base de conocimiento recién creada de la comunidad de Mautic
- Escribe una serie de instructivos y guías que ayuden a los usuarios de Mautic a ser más eficaces en la configuración y el uso de la aplicación.
- Se actualizó el instructivo en video para que se ajuste a la versión 3x de Mautic.
- Quita las imágenes y la información obsoletas.
- Volver a escribir la base de conocimiento para que sea más fácil de entender
- Garantiza la implementación adecuada de la guía de estilo o el patrón de la documentación de la base de conocimiento.
- Tener en cuenta la cadencia de lanzamiento, ya que el equipo de desarrollo estará ocupado con los lanzamientos de funciones menores
Evaluación de proyectos (del 25 al 29 de noviembre de 2019)
- Enviar un informe del proyecto y una evaluación de mis mentores
- Redactar y enviar un informe sobre mi experiencia como participante de la Temporada de Documentos