Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Máuticos
- Escritor técnico:
- Preferencia: 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 se almacena, organiza y luego comparte la información. Cuando se usa externamente, una base de conocimiento es donde los usuarios pueden ir para aprender todo lo que necesitan saber sobre los productos o servicios, la organización y la industria de una empresa. Por otro lado, una base de conocimiento interna se utiliza normalmente para permitir que la comunidad o los usuarios colaboren y distribuyan todo el conocimiento y la información de la empresa de manera interna. Si bien el contenido de las bases de conocimiento específicas varía en función de numerosos factores, en la mayoría de los casos se incluye información sobre cómo comenzar a usar productos específicos, aprovechar más las funciones avanzadas y solucionar problemas o 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, y respuestas a los miembros, los usuarios o la comunidad del público sin necesidad de hacerlo de forma individual.
La base de conocimiento de Mautic es un repositorio central de tutoriales, guías prácticas y prácticas recomendadas sobre temas relacionados con Mautic, ya sea de forma directa (p.ej., cómo hacer cosas en Mautic) o indirectamente (p.ej., estrategias de marketing más generales).
En el momento en que se redactó este documento, la base de conocimiento de Mautic era bastante nueva e incompleta, y la comunidad de Mautic desea 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 utilicen Mautic. La base de conocimiento de Mautic fue bastante informativa, pero se necesitaban instructivos actualizados y guías prácticas, además de crear nuevos instructivos 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 en 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 son dispersos o incompletos, y tampoco abarcan información sobre la versión actual de la matemática.
¿Por qué propones una mejora respecto de las áreas en las que me gustaría contribuir? La mejora propuesta tendrá como objetivo garantizar la eficiencia, la coherencia y la tranquilidad para cualquier usuario final. Contendrá instructivos escritos, guías prácticas y prácticas recomendadas, además de sus imágenes asociadas, incluirá instrucciones y explicaciones sobre cómo usar cada función de la matemática, 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
- Revisa la base de conocimiento.
- Actualiza los instructivos y las guías prácticas que se ajusten a la versión Mautic 3x.
- Crear recursos para la nueva base de conocimiento de la comunidad Mautic
- Escribe una serie de instructivos y guías prácticas que ayudarán a los usuarios de Mautic a ser más eficaces al configurar, usar y usar la aplicación.
- Actualiza el video instructivo para adaptarlo a la versión de Mautic 3x.
- Quita las imágenes y la información obsoletas.
- Reescribe la base de conocimiento para que sea más fácil de entender.
- Asegurar 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.
- Aprende nuevas técnicas y habilidades de escritura técnica que serán útiles durante la implementación del proyecto.
Vinculación con la comunidad (del 1 de agosto al 1 de septiembre)
- Configurar un canal y horario de comunicación (debido a la diferencia horaria)
- Definir mejor mis objetivos y establecer expectativas para ambos lados
- 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.
- Finalizar las funciones propuestas y otras modificaciones que deben realizarse 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 hacer lo siguiente :
- Revisa la base de conocimiento.
- Actualiza los instructivos y las guías prácticas que se ajusten a la versión Mautic 3x.
- Crear recursos para la nueva base de conocimiento de la comunidad Mautic
- Escribe una serie de instructivos y guías prácticas que ayudarán a los usuarios de Mautic a ser más eficaces al configurar, usar y usar la aplicación.
- Actualiza el video instructivo para adaptarlo a la versión de Mautic 3x.
- Quita las imágenes y la información obsoletas.
- Reescribe 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 patrón de la documentación de la base de conocimiento
- Se debe tener en cuenta la cadencia de lanzamiento, ya que el equipo de desarrollo estará ocupado con los lanzamientos de funciones secundarias.
Evaluación del proyecto (del 25 al 29 de noviembre de 2019)
- Enviar un informe del proyecto y una evaluación por parte de mis mentores
- Escribir y enviar un informe sobre mi experiencia como participante de la temporada de Documentos