Fase actual:
La temporada de Documentos 2020 finalizó el 15 de marzo de 2021. Consulta el cronograma.
Esta página contiene lineamientos para organizaciones de código abierto sobre cómo evaluar las propuestas de proyectos de redacción técnica y seleccionar los proyectos en los que desean ser mentores en Season of Docs.
Introducción
Los escritores técnicos envían sus propuestas de la temporada de Documentos para trabajar en un proyecto con la organización de código abierto que seleccionen. Los administradores del programa de Google reenvían las propuestas a las organizaciones de código abierto para la evaluación y selección de proyectos. Si deseas obtener detalles sobre los pasos involucrados, consulta la guía del administrador de la organización.
Evaluación de las propuestas técnicas del escritor
Habilidades y experiencia de escritura técnica
Examina la experiencia previa del escritor técnico. La propuesta del escritor técnico incluye información sobre su experiencia de escritura técnica más reciente. Lo ideal es que el solicitante 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 ese motivo, no es esencial que el escritor tenga experiencia con las APIs, los SDKs y otras plataformas para desarrolladores, incluso si el proyecto se enfoca en un público de desarrolladores.
Enfócate en las habilidades lingüísticas y comunicativas. Evalúa la propuesta del escritor técnico desde este punto de vista. Lo más importante es que comprendas lo que escribió la persona. Como mentor, tu función será ayudar al escritor técnico con los procesos, las herramientas y el código de código abierto; no es necesario que también tengas que revisar el texto de la documentación resultante. Si deseas revisar en profundidad el lenguaje de la propuesta, busca coherencia en la puntuación y redacción, la ortografía correcta y el lenguaje claro. ¿La frase es sencilla 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. Como parte de su propuesta, el escritor técnico tiene la oportunidad de proporcionar ejemplos de la documentación que desarrolló. Revisa el diseño general de las muestras de documentos. ¿Es lógico el diseño? ¿Puedes encontrar fácilmente el conjunto de documentos o documentos? ¿Hay contenido duplicado o hay brechas evidentes?
La propuesta
Verifica que la propuesta se ajuste a tus requisitos. ¿La propuesta se relaciona con alguna de las ideas de proyectos que enviaste para la temporada de Documentos de este año? Si el escritor técnico ha propuesto una nueva idea, comprueba que la propuesta se ajuste a las necesidades de tu proyecto de código abierto y que cuentas con las personas adecuadas para ayudarlo a alcanzar los objetivos del proyecto propuesto.
Busca entusiasmo y rigurosidad. ¿La propuesta demuestra que el escritor técnico está entusiasmado con el proyecto? Considera si se reflexionó y se trabajó en la propuesta, ya sea consultando a tu organización durante la fase de exploración o agregando sus propios pensamientos sobre cómo lograr los objetivos del proyecto.
Preguntas frecuentes
¿Cómo decidimos cuántos proyectos presentar?
Enfócate en uno o dos proyectos. Si tu organización tiene la capacidad de supervisar más que eso, puedes enviar más. Para cada proyecto de escritor técnico, necesitas al menos un mentor (preferentemente dos) que se comprometa a supervisar solo ese proyecto.
Lee la información sobre cómo funciona la asignación de ranuras de la temporada de Documentos.
¿Cómo elegimos qué propuesta de redacción técnica aceptar?
Asegúrate de seleccionar las mejores propuestas de escritores técnicos que hayas recibido. Es decir, seleccionar las propuestas que se adapten mejor a tus requisitos y a los lineamientos de evaluación que se mencionaron anteriormente.
¿Dónde están los formularios que necesitamos para enviar las propuestas seleccionadas?
Consulta la guía del administrador de la organización.