Fase actual:
El programa de la Temporada de Documentos de 2021 finalizó el 14 de diciembre de 2021. 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 de 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 el proyecto propuesto. Las organizaciones deben buscar su propio redactor técnico. Los escritores técnicos interesados en trabajar con organizaciones que participan en la Temporada de documentos de Google pueden encontrarse en el repositorio de GitHub de la Temporada de documentos de Google y en el canal#season-of-docs en el canal de Slack de Write the Docs.
Cómo evaluar a un escritor técnico
Te recomendamos que solicites ejemplos de documentación desarrollada anteriormente a los escritores técnicos que estás considerando para que puedas enfocarte en evaluar sus habilidades y experiencia en la escritura técnica.
Habilidades y experiencia en redacción técnica
Examina la experiencia previa del escritor técnico. Lo ideal es que el redactor técnico tenga experiencia previa en la redacción de documentación técnica para la industria de software. Uno de los objetivos de la Temporada de documentos de Google es brindarles a los redactores técnicos la oportunidad de participar en productos enfocados en los desarrolladores. Por esa razón, no es esencial que el escritor tenga experiencia con APIs, SDKs o con otras plataformas para desarrolladores, incluso si tu proyecto se enfoca en un público de desarrolladores.
Enfócate en las habilidades lingüísticas y 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 quieres hacer una revisión detallada del lenguaje del trabajo del escritor técnico, busca coherencia en la puntuación y la fraseología, una ortografía correcta y un lenguaje claro. ¿La frase es simple o complicada? ¿Las oraciones son breves o se extienden hasta que se vuelven difíciles de seguir?
Presta atención al diseño y el formato del documento. Verifica el diseño general de los documentos de muestra. ¿El diseño es lógico? ¿Puedes navegar fácilmente por el documento o el conjunto de documentación? ¿Hay duplicación de contenido o hay brechas evidentes?