Fase actual:
Desarrollo de la documentación. Consulta el cronograma.
En esta página, se incluyen sugerencias para organizaciones de código abierto sobre cómo evaluar y seleccionar al escritor técnico adecuado para su propuesta de proyecto para la temporada de documentos de Google.
Introducción
Las organizaciones de código abierto deben contratar a un escritor técnico para que trabaje en su proyecto propuesto. Las organizaciones deben buscar su propio escritor técnico. Los escritores técnicos interesados en trabajar con las organizaciones que participan en Google Season of Docs pueden encontrarse en el repositorio de GitHub de Google Season of Docs y en el canal#season-of-docs de la sección Write the Docs de Slack.
Inicio del proceso
Te recomendamos que comiences el proceso de encontrar un escritor técnico tan pronto como creas que te gustaría participar en Google Season of Docs.
Evaluar a un escritor técnico
Te recomendamos que solicites ejemplos de documentación desarrollada con anterioridad a los escritores técnicos que estás considerando para poder evaluar sus habilidades de escritura técnicas y su experiencia.
Habilidades y experiencia en redacción técnica
Examinar la experiencia previa del escritor técnico Lo ideal es que el escritor técnico tenga experiencia previa en la escritura de documentación técnica para la industria del software. Uno de los objetivos de Google Season of Docs es brindarles a los escritores técnicos la oportunidad de participar en los productos enfocados en los desarrolladores. Por ese motivo, no es esencial que el escritor tenga experiencia con las APIs, los SDKs y otras plataformas de desarrolladores, incluso si tu proyecto se enfoca en un público de desarrolladores.
Enfócate en el lenguaje y las habilidades de comunicación. Evalúa el trabajo anterior del escritor técnico desde este punto de vista. Lo más importante: ¿Puedes entender lo que escribió la persona? Si deseas hacer una revisión detallada del lenguaje del trabajo del escritor técnico, busca coherencia en la puntuación y redacción, la ortografía correcta y el lenguaje claro. ¿La redacción es simple o complicada? ¿Las oraciones son cortas o se repiten hasta que se vuelven difíciles de seguir?
Presta atención al diseño y distribución de los documentos. Verifica el diseño general de las muestras del documento. ¿El diseño es lógico? ¿Puedes navegar fácilmente por el conjunto de documentos o documentos? ¿Hay contenido duplicado o hay brechas evidentes?
Contratar a un redactor técnico
Las organizaciones deben contratar a un escritor técnico y completar el formulario de prueba de contratación de escritores técnico que se encuentra vinculado a continuación antes del 22 de mayo de 2024 a las 6:00 p.m. UTC.
Se completó la fase de contratación del escritor técnico.
Asegúrate de analizar la compensación y un programa de pagos con el escritor técnico antes de contratar. Recomendamos que las organizaciones creen un programa de pagos con escritores técnicos en función de los eventos importantes del proyecto, incluido un pago al inicio del proyecto. Ten en cuenta las fechas de pago, que solo ocurrirán dos veces durante el programa, y los importes cuando crees un programa de pagos.
Nota: Las organizaciones que no hayan contratado a un escritor técnico ni hayan enviado el Formulario de evidencia de contratación de escritores técnicos antes del 22 de mayo de 2024 a las 6:00 p.m. UTC no recibirán los fondos en la fecha del primer desembolso.