Fase actual:
La temporada de Documentos 2021 finalizó el 14 de diciembre de 2021. Consulta el 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. Puedes encontrar a los escritores técnicos interesados en trabajar con organizaciones que participan en Season of Docs en el repositorio de GitHub de Season of Docs y en el canal#season-of-docs de la sección Escribe los documentos en Slack.
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?