Preguntas frecuentes

Fase actual:
Finalización del proyecto. Consulta el cronograma.

General

¿Season of Docs de Google es un programa de reclutamiento?

No. Si te interesa trabajar para Google, visita el sitio web de trabajos de Google.

A nuestra organización le gustaría participar en la Temporada de Documentos de Google, pero no sabemos por dónde empezar

Consulta nuestra lista completa de ideas de proyectos. También puedes comunicarte con la comunidad de redacción técnica (prueba el canal #season-of-docs en el canal de Slack de Write the Docs o en tus canales de redes sociales para solicitar ayuda o propuestas).

¿Qué tipos de proyectos pueden proponer las organizaciones?

A continuación, le proponemos algunas ideas:

  • Crea un sitio de documentación en una plataforma que decida el escritor técnico y la organización de código abierto, y publica un conjunto inicial de documentos básicos en el sitio. Estos son algunos ejemplos de plataformas:

  • Refactoriza la documentación existente del proyecto de código abierto para proporcionar una experiencia del usuario mejorada o una arquitectura de la información más accesible.

  • Escribe una descripción general conceptual o una introducción a un producto o una función. A menudo, un equipo crea su documentación técnica de abajo hacia arriba, lo que da como resultado que hay muchos detalles, pero es difícil entender el producto en su totalidad. Un escritor técnico puede solucionar este problema.

  • Crea un instructivo para un caso de uso de alto perfil.

  • Crea un conjunto de guías prácticas enfocadas en tareas específicas.

  • Crea una guía para colaboradores que incluya información básica sobre cómo comenzar a ser colaborador del proyecto de código abierto, así como las reglas sobre los acuerdos de licencia, los procesos de solicitudes de extracción y revisiones, la compilación del proyecto, etcétera.

¿Un video es un posible proyecto para la Temporada de Documentos de Google?

Sí. Asegúrate de que los requisitos de video tengan un alcance adecuado y ten en cuenta que la producción de un video de alta calidad requiere tiempo y recursos significativos.

¿Una auditoría de documentación es un proyecto razonable para la Temporada de Documentos de Google?

Una auditoría de documentación es un gran proyecto para la Temporada de documentos de Google. Ten en cuenta la cantidad de documentación que ya tienes. Si tienes mucha, es posible que debas reducir el alcance (por ejemplo, solo auditar el contenido de los instructivos). Si tienes poca documentación o ninguna, te recomendamos que incluyas la creación de la documentación faltante de mayor prioridad como parte de tu proyecto.

¿Hay plantillas de documentación disponibles para que las usen las organizaciones y los redactores técnicos?

La Temporada de Documentos de Google tiene un repositorio de GitHub con una plantilla y una lista de tareas para realizar auditorías de documentación. Se agregarán otras plantillas a medida que se creen.

The Good Docs Project trabaja para crear algunas plantillas de documentación mínimas viables para el código abierto.

¿Las organizaciones deben usar los documentos que producen los redactores técnicos?

No. En ocasiones, los proyectos no salen como se espera o cambian los requisitos. No exigimos que las organizaciones usen la documentación ni otros materiales producidos, pero esperamos que la evaluación final y el caso de éxito incluyan un análisis de por qué no se usó la documentación y cómo el proyecto tomó la decisión de no usarla ni otros materiales.

¿Dónde se lleva a cabo la Temporada de Documentos de Google?

La Temporada de Documentos de Google se lleva a cabo completamente en línea. No es necesario viajar como parte del programa.

¿Cómo puedo mantenerme al tanto de la Temporada de Documentos de Google?

Visita la lista de distribución de anuncios en season-of-docs-announce para obtener las actualizaciones y los anuncios más recientes relacionados con la Temporada de Documentos de Google. Únete al grupo para recibir actualizaciones por correo electrónico.

¿Puedo agregar la programación de la Temporada de Documentos de Google a mi calendario?

Ve a http://goo.gle/2NeZVew para suscribirte al calendario de la Temporada de Documentos de Google.

¿Qué puedo hacer para ayudar a difundir la Temporada de Documentos de Google?

Puedes twittear sobre el programa, escribir entradas de blog, publicar videos o organizar una reunión o una sesión informativa en tu área. Tenemos algunos recursos y contenido de muestra que puedes usar para distribuir a tu comunidad (organización, grupo de escritores y otros contactos).

¿Cómo organizo o patrocino una sesión informativa o una reunión de la Temporada de Documentos de Google?

Puedes programar una reunión en el momento y el lugar que te resulte conveniente. Revisa las reglas del programa y usa el contenido de muestra.

¿Puedes compartir estadísticas sobre los programas de 2019 y 2020?

Sí, los resultados de la Temporada de Documentos de Google del programa de 2019 se pueden ver en el blog de código abierto de Google (2019 y 2020).

¿Recibiré una camiseta de la Temporada de Documentos de Google?

No, debido a limitaciones de envío internacional, Google Season of Docs ya no puede proporcionar camisetas a los participantes que completen correctamente su proyecto de Google Season of Docs.

¿Cómo puedo resolver otras dudas que pueda tener?

Consulta la guía para administradores de la organización y la guía para redactores técnicos.

Si después de leer toda la documentación aún no tienes una respuesta, considera analizar tus preguntas con la comunidad de Google Season of Docs en la lista de debates. Consulta la información sobre los canales de discusión y cómo comunicarte con nosotros.

¿Cómo puedo ser mentor de la Temporada de Documentos de Google?

La Temporada de Documentos de Google no tiene un rol de mentor formal. Las organizaciones deben especificar cómo se incorporarán y apoyarán a los redactores técnicos, y cómo se revisarán y aprobarán sus contribuciones de documentación como parte de la solicitud de la organización. Si te interesa asesorar a redactores técnicos como parte de la Temporada de documentos de Google, comunícate con los administradores de tu organización para ofrecerte como voluntario.

¿Season of Docs de Google es como Google Summer of Code?

No. Google Season of Docs está diseñado para personas con alguna experiencia en la escritura técnica y no como un programa de mentoría como Google Summer of Code.

Para escritores técnicos

¿Cuándo pueden postularse los redactores técnicos a la Temporada de Documentos de Google?

Google Season of Docs no tiene una solicitud formal de escritor técnico. Para participar en Google Season of Docs como escritor técnico, comunícate directamente con las organizaciones de código abierto siguiendo las instrucciones que se indican en la página del programa Google Season of Docs. También puedes expresar tu interés agregándote al Directorio de redactores técnicos de la Temporada de Docs de Google. Consulta la guía para redactores técnicos para obtener más información.

¿Qué herramientas y frameworks de documentación debo conocer para participar en la Temporada de documentos de Google?

Las herramientas y los frameworks de documentación que usarás dependen de la organización con la que te interesa trabajar. Parte del objetivo de la Serie de Documentos de Google es que los proyectos de código abierto ayuden a los redactores técnicos a obtener más información sobre las herramientas y los frameworks involucrados en la documentación de productos de código abierto. Por esa razón, no suele ser un requisito que tengas conocimientos detallados sobre plataformas de documentación específicas antes de comenzar tu proyecto de la Temporada de documentos de Google.

Dicho esto, la mayoría de las organizaciones de código abierto usan algún tipo de Markdown o algún otro lenguaje de marcado para su documentación. Te recomendamos que averigües qué lenguaje usa la organización que elegiste y que te familiarices con la sintaxis. Markdown es un buen punto de partida, ya que los archivos README de GitHub usan una variante de Markdown. Consulta la guía de GitHub sobre Markdown.

Averigua si la organización que elegiste ya aloja su documentación en un sitio web y, de ser así, qué plataforma usa. La plataforma puede ser un generador de sitios estáticos, como Jekyll, Sphinx o Hugo, o la organización puede alojar sus documentos en Read the Docs o GitHub Pages. Cuando averigües qué plataforma usa la organización, explora y experimenta con el lenguaje y el framework relevantes. Esto te ayuda a comenzar rápidamente con tu proyecto de código abierto y te coloca en una buena posición para brindar consejos sólidos al proyecto de código abierto que elijas.

¿Qué lenguajes de programación debo saber para participar en los proyectos de la Temporada de Documentos de Google?

Según la naturaleza de tu proyecto de documentación, es posible que debas familiarizarte con un lenguaje de programación. Ten esto en cuenta cuando elijas y propongas un proyecto de documentación, y consulta a la organización de código abierto sobre el nivel de familiaridad requerido.

¿Los escritores técnicos que ya trabajan en un proyecto de código abierto pueden seguir trabajando en él como parte de la Temporada de Documentos de Google?

Sí, pero la organización debe tener en cuenta la relación anterior o en curso del escritor técnico con el proyecto en su propuesta.

¿Cuáles son los requisitos de elegibilidad para participar?

¿Necesito experiencia o capacitación previa como redactor técnico?

Se prefiere tener experiencia o capacitación previa en redacción técnica, pero no es esencial. Cuando envíes una declaración de interés a una organización, puedes describir tu experiencia o cualquier capacitación que hayas tenido en redacción técnica. Debes poder proporcionar evidencia que demuestre tu interés en la documentación técnica o de código abierto, incluidos ejemplos de documentación que hayas escrito. La organización de código abierto buscará redactores técnicos con el nivel de experiencia que necesita para garantizar que se completen con éxito sus proyectos de la Temporada de documentos de Google.

¿Me pagarán por participar en la Temporada de Documentos de Google?

Sí. Google proporcionará subvenciones a las organizaciones aceptadas para que las usen con el fin de emplear a escritores técnicos.

¿Cómo es una buena declaración de interés de un escritor técnico?

Las mejores declaraciones de interés son de escritores técnicos que se toman el tiempo para interactuar y analizar sus ideas con la organización de código abierto que eligieron antes de enviar sus declaraciones. Consulta la guía para crear tu declaración de interés.

¿Cuánto tiempo lleva participar en la Temporada de Documentos de Google?

El tamaño de los proyectos varía, pero oscila entre un compromiso de 5 a 30 horas por semana durante el programa. Sin embargo, la cantidad de tiempo que dedicas a esta tarea depende de la naturaleza del proyecto que acordaste con tu organización. Antes de realizar el compromiso, debes evaluar el proyecto y analizar una estimación de tiempo con la organización de código abierto.

¿Puedo enviar una solicitud de organización para crear documentación para un proyecto de código abierto como persona física? Me gustaría crear una serie de entradas de blog, videos y otros materiales sobre cómo usar un proyecto o una herramienta de código abierto, pero no formo parte del proyecto ni colaboro en él.

No, solo debes enviar una propuesta si puedes recibir fondos en nombre del proyecto de código abierto. Si te interesa participar en un proyecto, comunícate con él y colabora en una propuesta de solicitud.

Soy estudiante. ¿Puedo participar en la Temporada de Documentos de Google? ¿La Temporada de Documentos de Google me enseñará a ser redactor técnico?

Los estudiantes pueden trabajar con organizaciones aceptadas, pero la Temporada de Documentos de Google no está diseñada para enseñar habilidades de redacción técnica. Se espera que los escritores técnicos participantes tengan habilidades profesionales de escritura técnica o experiencia relevante equivalente. Los estudiantes que quieran participar deben asegurarse de destacar su experiencia relevante en escritura y edición cuando se postulen.

¿Puedo participar como escritor técnico en Google Season of Docs y como estudiante en Google Summer of Code?

No se recomienda que los colaboradores nuevos o los estudiantes aceptados en Google Summer of Code se postulen para ser redactores técnicos de Google Season of Docs.

La Temporada de documentos de Google no está destinada a principiantes, sino a personas que ya tienen habilidades y experiencia sólidas o excelentes en la escritura técnica. Los escritores técnicos de la Temporada de Documentos de Google no reciben orientación, sino que deben organizarse por su cuenta y motivarse para idear un plan para abordar el proyecto de la organización con una orientación mínima de los administradores de la organización y otros miembros de la comunidad.

Como escritor técnico, ¿cómo puedo comunicarme con los administradores del programa de Google Season of Docs si tengo más preguntas o inquietudes?

Para comunicarte con los administradores del programa de Google Season of Docs, envía un correo electrónico a season-of-docs@google.com.

¿Puede una empresa o consultoría de redacción técnica participar en la Temporada de documentos de Google?

Sí, una organización puede contratar a una empresa para que realice el trabajo que se describe en su propuesta.

¿Cómo puedo hacer referencia a la Temporada de Documentos de Google en mi currículum?

Indícalo como lo harías con cualquier otro trabajo independiente: "Trabajaba como redactor técnico para [nombre del proyecto] como parte del programa de la Temporada de Documentos de Google".

¿Proporcionan certificados de finalización por participar en la Temporada de Documentos de Google?

Google Season of Docs no puede enviar certificados ni confirmaciones de participación en el proyecto a los redactores técnicos.

Para administradores de organizaciones de código abierto

¿Cuáles son los requisitos de elegibilidad para una organización de código abierto?

Para poder participar como organización, debes ser un grupo que ejecute un proyecto activo de software libre o de código abierto, como BRL-CAD. El proyecto no tiene que ser una entidad legalmente constituida. Para participar en el programa, las organizaciones deben haber producido y lanzado software con una licencia aprobada por la Iniciativa de código abierto y tener al menos dos colaboradores que actúen como administradores de la organización durante todo el programa de Google Season of Docs.

Consulta también los requisitos de elegibilidad que se describen en las reglas del programa y en los Programas de sanciones y la información del país del Departamento del Tesoro de EE.UU.

¿El término "organización" equivale a un proyecto de código abierto?

Una organización puede tener uno o más proyectos de código abierto. Algunas organizaciones, como las fundaciones, pueden tener varias suborganizaciones, cada una con uno o más proyectos de código abierto. Si tu organización tiene suborganizaciones independientes, envía solicitudes y propuestas independientes para cada una de ellas.

¿Una organización puede enviar más de una solicitud de propuesta?

No. Solo envía una solicitud por organización. Si tu organización tiene suborganizaciones (por ejemplo, tu organización es una fundación con muchos proyectos de código abierto individuales), cada proyecto debe enviar su propia solicitud, incluso si la organización superior se encargaría de los fondos de la subvención.

¿Puede un grupo de proyectos de código abierto enviar una propuesta en conjunto para trabajar en un solo proyecto de documentación?

Una organización debe enviar la solicitud de propuesta y ser responsable de coordinar el trabajo y la asistencia de otros proyectos participantes. (por ejemplo, un grupo de proyectos de código abierto pequeños que son complementos de un proyecto más grande que desean trabajar en una guía de instrucciones conjunta para crear complementos debe elegir una organización para dirigir el proyecto).

¿Cómo recibirá los fondos mi organización?

Para recibir fondos, tu organización debe tener una cuenta de Open Collective.

¿Las organizaciones reciben dinero por participar en la Temporada de Documentos de Google?

Las organizaciones pueden incluir fondos para la administración, la tutoría o la revisión de trabajos como parte de los presupuestos de sus proyectos.

¿Google cubre las tarifas por procesamiento de pagos?

Google no cubre las tarifas de procesamiento de pagos, ya que suelen diferir según la forma de pago. Sin embargo, Google cubre la tarifa de la plataforma de Open Collective y, si decides usar Open Collective como tu host fiscal, esa tarifa también se cubre. Consulta la guía para recibir subvenciones para obtener más información.

¿Cómo debería mi organización presupuestar el costo de un escritor técnico?

Te recomendamos que consultes la encuesta de salarios de Write the Docs y que calcules las tarifas por hora. También puedes unirte al canal de Write The Docs en Slack y preguntar en el canal #season-of-docs si hay escritores técnicos interesados en ofertar.

¿Mi organización puede usar la subvención de la Temporada de Documentos de Google para pagar a un colaborador actual?

Sí. Sin embargo, las propuestas de proyectos deben ser para trabajos nuevos (incluidos trabajos de mantenimiento, revisión o actualizaciones de la documentación existente). No puedes solicitar una subvención para pagar un trabajo que ya se completó.

¿Mi organización puede trabajar con estudiantes que escriban documentación técnica?

Puedes optar por que estudiantes redactores técnicos trabajen en tu proyecto. Si decides trabajar con estudiantes, te recomendamos que limites la participación a los estudiantes que cumplan con los siguientes requisitos:

  • Debes tener más de 18 años.
  • Estar inscrito en un programa o curso de redacción o comunicación técnica
  • Tener acceso demostrable a la tutoría de redacción técnica a través de su programa o curso

¿Mi organización puede trabajar con más de un escritor técnico?

Tu organización puede seleccionar y pagar a más de un escritor técnico, pero todos los escritores técnicos que trabajan con tu organización deben trabajar en el proyecto que propusiste. Trabajar con varios redactores técnicos agregará más complejidad a tu proyecto y requerirá más tiempo de voluntariado y administración.

¿Mi organización puede contratar una empresa de redacción técnica para trabajar en nuestro proyecto?

Sí, tu organización puede contratar una empresa de redacción técnica para trabajar en tu proyecto. Asegúrate de que se pueda pagar a la empresa que contrates a través de Open Collective.

Nuestro escritor técnico abandonó el programa antes de que terminara. ¿Nuestra organización aún es apta para recibir los fondos restantes?

Se recomienda encarecidamente que los proyectos intenten encontrar un nuevo escritor técnico para completar su proyecto antes de que finalice el programa. Sin embargo, el desembolso de los fondos restantes no se basa en la finalización del proyecto, sino en la finalización del caso de éxito y la evaluación final.

Si no pudiste completar el proyecto, tu caso de éxito debe examinar el motivo. Por ejemplo, es posible que hayas descubierto que tus herramientas de documentación son muy complejas y que representan un obstáculo para incorporar a un escritor técnico, o que tu proyecto implicó probar y actualizar instructivos y requirió una amplia experiencia de codificación. ¿Qué recomendarías a otros proyectos, según tu experiencia? Incluye esa información en tu caso de éxito.

¿Se puede revisar una solicitud de organización antes de la fecha límite de envío?

Lamentablemente, Google Season of Docs no puede proporcionar comentarios sobre la solicitud de la organización.

¿Cómo deben las organizaciones definir el alcance de sus propuestas de proyectos?

Cuando desarrolles ideas de proyectos, intenta encontrar los proyectos más pequeños que le aporten valor a la organización (pero que se puedan expandir si el tiempo lo permite). Cuanto más pequeño, mejor. Cuando crees tu propuesta de proyecto, te recomendamos que te ciñas a proyectos más pequeños y detallados en lugar de proyectos más grandes que estén menos especificados. Si tu proyecto requiere mucha experiencia en el dominio, intenta incluir proyectos en los que alguien sin esos antecedentes pueda trabajar.

¿Puedo participar como administrador de una organización en Google Season of Docs y como mentor en Google Summer of Code?

Sí. Google Season of Docs y Google Summer of Code son programas independientes. Si tienes el ancho de banda para participar en ambos programas, no hay problema.

Nuestra organización participó en programas anteriores de la Temporada de Documentos de Google. ¿Nuestra organización puede volver a postularse?

Sí, las organizaciones que participaron en programas anteriores de la Temporada de Documentos de Google pueden volver a postularse.

Datos archivados

¿Cómo quito mi información del archivo de la Temporada de Documentos de Google?

Comunícate con nosotros para que quitemos tu información.