Esta página contiene los detalles de un proyecto de redacción técnico aceptado para Google Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Máuticos
- Redactor técnico:
- Favorito Kelvin
- Nombre del proyecto:
- Base de conocimiento
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Se puede abstraer
Una base de conocimiento es un repositorio centralizado donde la información se almacena, organiza y luego se comparte. Cuando se usa externamente, una base de conocimiento es el lugar al que los usuarios pueden acudir para aprender todo lo que necesitan saber sobre los productos o servicios de una empresa, su organización y su industria. Por otro lado, una base de conocimiento interna se utiliza normalmente 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 en función de numerosos factores, la mayoría suele incluir información sobre cómo comenzar a usar productos específicos, aprovechar más las funciones avanzadas y solucionar problemas comunes. El principal beneficio de crear y presentar una base de conocimiento al público es que te permite brindar información detallada, instantánea y a pedido, además de respuestas, a los miembros, los usuarios o la comunidad del público sin tener que hacerlo de forma individual.
La base de conocimientos de Mautic es un repositorio central de instructivos, guías prácticas y prácticas recomendadas sobre temas relacionados con Mautic, ya sea de forma directa (p.ej., cómo hacer tareas en Mautic) o indirectamente (p.ej., estrategias de marketing más generales).
Al momento de la redacción de este documento, la base de conocimiento de Mautic es bastante nueva e incompleta, y la comunidad de Mautic desea utilizar este proyecto para mejorar su manera de proporcionar información en profundidad y a pedido a la documentación del usuario para permitir que los usuarios finales tengan una experiencia fluida cuando utilizan Mautic. La base de conocimiento de Mautic fue bastante informativa, pero se necesitaron instructivos y guías prácticas actualizadas, así como para crear otros nuevos y hacer coincidir la versión 3x de Mautic.
Mis primeras impresiones cuando revisé la documentación existente Actualmente, la base de conocimiento de Mautic está disponible https://kb.mautic.org/. Algunos de los instructivos, guías prácticas y temas de prácticas recomendadas de la documentación no están actualizados y están dispersos o incompletos, y tampoco abarcan información sobre la versión actual de la matemática.
¿Por qué la mejora que propones respecto de 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. Contiene instructivos escritos y guías prácticas y prácticas recomendadas, además de sus imágenes asociadas, y también incluirá instrucciones y explicaciones sobre cómo usar cada función de la lógica, actualizada, fácil de navegar y comprensible.
Análisis
La base de conocimiento de Mautic se escribió en el CMS de archivo plano Grav y con el tema KLB4. Investigué mucho sobre las formas de mejorar la documentación de la base de conocimiento.
Objetivos del proyecto
- Revisar la base de conocimiento
- Actualiza los instructivos y las guías prácticas que se ajustan a la versión Mautic 3x.
- Crea recursos para la nueva base de conocimiento de la comunidad mautic
- Escribe una serie de instructivos y guías que ayudarán a los usuarios de Mautic a ser más eficaces en la configuración y el uso de la aplicación.
- Actualiza el video instructivo para adaptarlo a la versión 3x de Mautic.
- Quita las imágenes y la información obsoletas.
- Reescribe la base de conocimiento para que sea más fácil de comprender.
- Garantizar la implementación adecuada de la guía de estilo o patrón de la documentación de la base de conocimiento
Cronograma
Antes del 1 de agosto
- Seguir contribuyendo a la organización
- Familiarízate con la documentación de la base de conocimiento y la versión actual de Mautic.
- Aprenderás nuevas técnicas y habilidades de escritura técnicas que serán útiles durante la implementación del proyecto.
Vinculación con la comunidad (del 1 de agosto al 1 de septiembre)
- Establecer un canal de comunicación y un horario (debido a la diferencia horaria)
- Definir mejor mis objetivos y establecer expectativas para ambos lados
- Obtén más información sobre la comunidad y el producto
- Debatir sobre la estructura de documentación propuesta con los mentores y otros miembros de la organización.
- Finaliza las funciones propuestas y otras modificaciones que deben hacerse en la documentación existente.
Período de documentación
- Semana 1 (del 2 de septiembre al 22 de noviembre)
- Durante estos períodos, trabajaba directamente con mis mentores para lograr lo siguiente :
- Revisar la base de conocimiento
- Actualiza los instructivos y las guías prácticas que se ajustan a la versión Mautic 3x.
- Crea recursos para la nueva base de conocimiento de la comunidad mautic
- Escribe una serie de instructivos y guías que ayudarán a los usuarios de Mautic a ser más eficaces en la configuración y el uso de la aplicación.
- Actualiza el video instructivo para adaptarlo a la versión 3x de Mautic.
- Quita las imágenes y la información obsoletas.
- Reescribe la base de conocimiento para que sea más fácil de comprender.
- Asegúrate de que la guía de estilo o patrón de la documentación de la base de conocimiento se implemente de forma adecuada.
- Se debe tener en cuenta la cadencia de lanzamiento, ya que el equipo de desarrollo está ocupado con los lanzamientos de funciones menores.
Evaluación del proyecto (del 25 al 29 de noviembre de 2019)
- Enviar un informe del proyecto y una evaluación de mis mentores
- Escribir y enviar un informe sobre mi experiencia como participante de la temporada de Documentos