Fase actual:
Datos anunciados
cronograma.
Esta página contiene sugerencias para organizaciones de código abierto sobre cómo evaluar y seleccionar al escritor técnico adecuado para su propuesta de proyecto de temporada de Documentos.
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 organizaciones que participan en Season of Docs pueden encontrarse en el repositorio de GitHub de Season of Docs y en el canal#season-of-docs de la serie Escribe los documentos 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 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 concentrarte en evaluar sus habilidades y experiencia de escritura técnica.
Habilidades y experiencia de escritura técnica
Examina 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 Season of Docs es brindar a los escritores técnicos la oportunidad de participar en los productos centrados en los desarrolladores. Por esa razón, no es esencial que el escritor tenga experiencia con las APIs, los SDKs y otras plataformas para desarrolladores, incluso si tu proyecto se enfoca en un público de desarrolladores.
Enfócate en las habilidades lingüísticas y comunicativas. Evalúa el trabajo anterior del escritor técnico desde este punto de vista. Lo más importante es que comprendas 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 hacen difíciles de seguir?
Presta atención al diseño de documentos. Revisa el diseño general de las muestras del documento. ¿Es lógico el diseño? ¿Puedes aprender fácilmente sobre el documento o conjunto de documentos? ¿Hay contenido duplicado o hay brechas evidentes?
Contratar a un escritor 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 16 de mayo de 2022 a las 6:00 p.m. UTC.
Se completó la fase de contratación del escritor técnico.
Asegúrate de analizar la remuneración y una programación de pagos con el escritor técnico antes de contratar el servicio. Recomendamos que las organizaciones creen un programa de pagos con escritores técnicos en función de los hitos 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 contrataron a un escritor tecnológico y no enviaron el formulario de comprobante de contratación de escritores técnicos antes del 16 de mayo de 2022 a las 6:00 p.m. UTC no recibirán fondos en la primera fecha de desembolso.