Última actualización el
26 dic. 2022
Presentación del proceso de revisión
1. Definición de la función:
La función del comisario consiste es revisar los tutoriales en la aplicación y proporcionar una revisión y comentarios de evaluación de calidad (QE) al autor.
2. Flujo de trabajo
Durante la revisión del contenido inicial por parte del comisario
- La vista TB Content Production view permite actualizar el progreso.
- El estado TB_content_status se actualiza a medida que el tutorial avanza por el canal.
- Ultima el título del tutorial en colaboración con el Community Manager. Una vez el comisario y el Community Manager están de acuerdo en un título final, el comisario añade este título de Tutorial Builder al campo final_title.
- El título debe ultimarse y subirse a Alexandria antes de enviar el tutorial a la fase de evaluación de la calidad (QE).
- El comisario aprobará o rechazará el tutorial (puede haber más de una ronda).
- Aprobado: el tutorial pasa a la revisión de QE.
- Rechazado:
- El comisario añade comentarios de revisión al documento Author Brief y etiqueta al autor.
- El comisario rechaza el tutorial en Tutorial Builder.
- Los autores reciben una notificación por correo electrónico en la que se indica que su tutorial necesita atención, que se puede encontrar en su Author Brief en esta carpeta: +Author feedback on tutorials
- El autor modifica, previsualiza y vuelve a enviar el tutorial en Tutorial Builder.
- El comisario aprueba el tutorial.
- Durante la revisión del experto de QE
- La vista TB Content Production view permite actualizar el progreso.
- El estado TB_content_status se actualiza a medida que el tutorial avanza por el canal.
- Si QE rechaza un tutorial, pasa de nuevo al comisario en Tutorial Builder. Los comentarios quedan registrados en el campo qe_comments, con el nombre del comisario mediante una etiqueta con el símbolo @.
- Si no es necesaria ninguna corrección, el comisario menciona al QE con @ en el campo qe_comments, seguido de la fecha y las iniciales, aprueba el tutorial en Tutorial Builder y cambia el estado en TB_content_status a “Curator: QE content approved”.
- Si es necesario realizar cambios:
- El comisario añade comentarios de revisión al Author Brief y etiqueta al autor.
- El comisario rechaza el tutorial en Tutorial Builder.
- El autor recibe una notificación por correo electrónico en la que se indica que su tutorial necesita atención, que se puede encontrar en el documento de esta carpeta: +Author feedback on tutorials
- El autor modifica, previsualiza y vuelve a enviar el tutorial en Tutorial Builder.
- El comisario comprueba las correcciones, etiqueta a QE en el campoqe_comments si es necesario, informa a QE de las actualizaciones, añade la fecha y las iniciales y aprueba el tutorial en Tutorial Builder.
- Para Illustrator: el comisario proporciona comentarios de revisión sobre las imágenes y el texto de las secciones. Añade filas distintas para los comentarios relativos a las imágenes.
- La vista TB Content Production view permite actualizar el progreso.
3. Pautas para el comisario
- El comisario revisa lo que verá el usuario final.
- Comprueba la facilidad de uso básica del tutorial.
- Se asegura de que las indicaciones se añaden y señalan al lugar correcto.
- Se asegura de que el tutorial cumple con las prácticas recomendadas, las pautas de activos y las características de las imágenes.
- Conoce las limitaciones actuales de Tutorial Builder y sugiere soluciones alternativas a los bloqueos.
- Determina si el contenido está descrito de la mejor forma posible para el usuario final.
- Tiene en cuenta el nivel de usuario: principiante, intermedio y avanzado.
- Se asegura de que cada paso se crea con el método de preferencia según lo previsto.
- Los comisarios deben conocer el mejor enfoque para escribir una indicación para poder percatarse de los lugares en los que los autores no añadieron la indicación correctamente.
- Evalúa si el tutorial se centra en el tema planificado y en los objetivos de aprendizaje.
- Colabora con el autor para redirigir el tutorial hacia su enfoque cuando sea necesario.
- Comprueba el Archivo de inicio para asegurarse de que funciona correctamente y de que coincide con a) las instrucciones y b) las limitaciones de la versión actual de Tutorial Builder.
- Corrección de estilo:
- Comprueba los errores tipográficos.
- Comprueba las oraciones mal formadas.
- Comprueba la puntuación.
- Permite que el tutorial tenga el propio toque del autor.
- Si un comisario se encuentra con un problema técnico que cree que puede ser un error de Tutorial Builder, debe consultarlo con el Community Manager primero.
- Debe estar preparado para crear un ticket de Jira si fuera necesario.
Nota:
Consulta la interfaz de xeTaxonomy para ver listas específicas de cada aplicación para las categorías de etiquetas.
- Si no puedes acceder a este enlace, ponte en contacto con Rachael Maddison e indica tu nombre, equipo y la razón por la que necesitas acceso.
Si no estás seguro de que etiqueta utilizar en alguno de los campos, consulta las Pautas de etiquetado.
Etiquetado de tutoriales publicados
- Accede a la pestaña Publicado como comisario.
- Selecciona el tutorial.
- En el menú más acciones, selecciona Crear nueva versión.
- De esta forma, se creará una nueva versión (p. ej.: 2.1) del tutorial y pasa a la pestaña En revisión del comisario. El tutorial sigue apareciendo en la pestaña Publicado (p. ej.: versión 2.0) y la opción Crear nueva versión cambia a Versión en curso
- Accede a la pestaña En revisión del comisario.
- Busca el tutorial.
- En el menú más acciones, selecciona Asignársela personalmente si vas a hacer los cambios.
- Si has seleccionado Asignársela personalmente, cambia al modo Autor.
- Accede a la pestaña Necesita revisión como autor.
- Selecciona el tutorial.
- En el menú más acciones, selecciona Editar.
- Edita el tutorial (añade las etiquetas de taxonomía).
- Cuando hayas terminado, haz clic en Guardar.
- Este paso es esencial, pues al añadir las etiquetas de taxonomía, el tutorial no se guarda de forma automática.
- Envía el tutorial.
- El tutorial se envía al comisario.
- El tutorial se retira de la pestaña Necesita revisión del comisario y el autor.
- El tutorial ha pasado a la pestaña En revisión del comisario con el estado Listo para Curator.
- Pasa al modo Comisario y aprueba el tutorial.
- Estado del tutorial = Listo para QE
- Accede a la función de QE y aprueba el tutorial.
- Estado del tutorial = Listo para LOC