Trabajo con un escritor técnico

Fase actual:
La temporada de Documentos del programa 2019 finalizó el 6 de marzo de 2020. Consulta el cronograma.

A continuación, se incluyen algunos lineamientos para organizaciones de código abierto sobre cómo trabajar con un escritor técnico al que asesoras para Season of Docs:

  • Presenta al escritor técnico el mundo del código abierto y a tu comunidad.
  • Ayuda al escritor técnico a usar las herramientas y los procesos involucrados para contribuir a tu proyecto.
  • Explica tu producto en detalle para que el escritor técnico obtenga una comprensión conceptual sólida del producto. Esto puede ayudar al escritor técnico a sentirse más seguro y ser más confiable a la hora de escribir para el proyecto.
  • Describe las necesidades de tu público, es decir, las necesidades de los desarrolladores que usan tu producto o de otros grupos que lo usan.
  • Taller de los casos de uso importantes con el escritor técnico para ayudarlo a diseñar la documentación requerida.
  • Analiza el código cuando el escritor técnico deba comprenderlo antes de escribir los documentos.
  • Poner al escritor técnico en contacto con los expertos en la materia necesarios Es decir, los desarrolladores y otros colaboradores del proyecto responsables de los aspectos del producto que se abordarán en la documentación.
  • Asegúrate de que el escritor técnico obtenga el tiempo y los recursos que necesita de los expertos en la materia y de cualquier otro miembro de la comunidad.
  • Trabaja con el escritor técnico para agregar muestras de código significativas a los documentos cuando corresponda.

Cuestiones que debes tener en cuenta

Los mentores de código abierto de Season of Docs no son necesariamente escritores técnicos. No es necesario que los mentores tengan habilidades de documentación. Los escritores técnicos aplican esas habilidades al proyecto y a la relación de mentoría.

En cambio, los mentores aportan su conocimiento sobre la comunidad de código abierto, el producto y los procesos y herramientas que se usan en el proyecto de código abierto.

Un resultado importante de la relación de tutoría debe ser que el escritor técnico tenga una experiencia gratificante y exitosa en la temporada de Documentos de este año. Una experiencia feliz mejora las posibilidades de que el escritor técnico siga contribuyendo al proyecto de código abierto después del cierre de la temporada de Documentos de este año y de que otros escritores técnicos comiencen a trabajar con código abierto con entusiasmo.