Preguntas frecuentes

Fase actual:
Desarrollo de la documentación. Consulta el cronograma.

General

¿Es Google Season of Docs un programa de reclutamiento?

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

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

Consulta la lista completa de ideas de proyectos. También puedes comunicarte con la comunidad de redacción técnica (prueba el

en el canal de la temporada de documentales

Escribe los Documentos en Slack 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 decidan 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.

  • Escribir una descripción general conceptual de un producto o función, o una introducción a ellos A menudo, un equipo crea su documentación técnica de abajo hacia arriba, lo que da como resultado muchos detalles, pero es difícil comprender el producto en su conjunto. Un escritor técnico puede solucionarlo.

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

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

  • Crea una guía para colaboradores que incluya información básica sobre cómo colaborar en el proyecto de código abierto y las reglas relacionadas con los contratos de licencia, los procesos para las solicitudes de extracción y las revisiones, la compilación del proyecto, etcétera.

¿Un video podría ser un 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 mucho tiempo y recursos.

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

Una auditoría de la documentación es un gran proyecto para Google Season of Docs. 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 del instructivo). Si tienes poca o ninguna documentación, recomendamos que incluyas la creación de la documentación faltante con mayor prioridad como parte del proyecto.

¿Hay plantillas de documentación disponibles para que usen las organizaciones y los escritores 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 la documentación. Se agregarán otras a medida que se creen.

The Good Docs Project está trabajando con el objetivo de crear algunas plantillas de documentación viables mínimas para código abierto.

¿Las organizaciones deben utilizar los documentos producidos por escritores 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 se tomó la decisión de no usar la documentación ni otros materiales en el proyecto.

¿Dónde ocurre la temporada de Documentos de Google?

La temporada de Documentos de Google se realiza completamente en línea. No es necesario viajar como parte del programa.

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

Visita la lista de distribución de anuncios en season-of-docs-announce para ver 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 a mi calendario el cronograma de la temporada de Documentos de Google?

Visita http://goo.gle/2NeZVew para suscribirte al calendario de temporada de Documentos de Google.

¿Qué puedo hacer para ayudar a correr la voz sobre la temporada de Documentos de Google?

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

¿Cómo puedo organizar o organizar una reunión o sesión informativa de la temporada de Documentos de Google?

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

¿Hay estadísticas que puedas compartir sobre los programas de 2019 y 2020?

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

¿Me dará una camiseta de la temporada de Documentos de Google?

No, debido a restricciones de envío internacional, Season of Docs de Google ya no puede entregar camisetas a los participantes que completen con éxito 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 de escritor técnico.

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

¿Cómo puedo ser mentora de Google Season of Docs?

La temporada de Documentos de Google no tiene un rol formal de mentor. Las organizaciones deben especificar cómo se integrarán y apoyarán los escritores 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 escritores técnicos como parte de Google Season of Docs, comunícate con los administradores de tu organización para que se ofrezcan como voluntarios.

¿Es Google Season of Docs como Google Summer of Code?

No. La temporada de Documentos de Google está destinada a personas con cierta experiencia en escritura técnica, no está diseñada como un programa de mentoría como Google Summer of Code.

Para escritores técnicos

¿Cuándo pueden los escritores técnicos postularse para Google Season of Docs?

La temporada de Documentos de Google no cuenta con una aplicación formal de redactor 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 si te unes al Directorio de escritores técnicos de la temporada de documentos de Google. Consulta la guía para escritores técnicos si quieres obtener más información.

¿Qué herramientas y frameworks de documentación debo conocer para participar en Google Season of Docs?

Las herramientas de documentación y los frameworks que usarás dependen de la organización con la que te interesa trabajar. Parte del objetivo de Google Season of Docs es que los proyectos de código abierto ayuden a los escritores 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 ese motivo, no es un requisito que tengas conocimientos detallados de plataformas de documentación específicas antes de comenzar tu proyecto de temporada de Documentos de Google.

Dicho esto, la mayoría de las organizaciones de código abierto usan una versión de Markdown o de 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 comienzo, 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 elegida 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ático, como Jekyll, Sphinx o Hugo, o la organización puede alojar sus documentos en Lee los documentos o las páginas de GitHub. Cuando sepas 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 proporcionar consejos sólidos al proyecto de código abierto que elijas.

¿Qué lenguajes de programación debo conocer para participar en proyectos de Google Season of Docs?

Según la naturaleza de tu proyecto de documentación, es posible que debas conocer 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.

¿Pueden los escritores técnicos que ya trabajan en un proyecto de código abierto seguir trabajando en él como parte de Google Season of Docs?

Sí, pero la organización debe tener en cuenta la relación previa o continua 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 escritor técnico?

Se prefiere tener experiencia o capacitación previa en redacción técnica, pero no es esencial. Cuando envías 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 alguna 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á escritores técnicos con el nivel de experiencia que la organización necesita para garantizar la finalización exitosa de sus proyectos de Google Season of Docs.

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

Sí. Google otorgará subsidios a las organizaciones aceptadas para emplear 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 la participación en Temporada de Documentos de Google?

Los tamaños de los proyectos varían, pero varían entre un compromiso de 5 a 30 horas por semana durante el programa. Sin embargo, la cantidad de tiempo que inviertas dependerá de la naturaleza del proyecto que hayas acordado con tu organización. Antes de confirmar, 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 como persona para crear documentación para un proyecto de código abierto? Me gustaría crear una serie de entradas de blog, videos u otro material sobre cómo usar un proyecto o una herramienta de código abierto, pero no soy parte del proyecto ni es parte de él.

No, solo debes enviar una propuesta si puedes recibir fondos en nombre del proyecto de código abierto. Si te interesa participar como parte de 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 escritora técnica?

Los estudiantes son aptos para trabajar con organizaciones aceptadas, pero Google Season of Docs no tiene como objetivo enseñar habilidades de escritura técnicas. Se espera que los escritores técnicos participantes tengan habilidades de redacción técnica profesional o experiencia relevante equivalente. Los estudiantes que deseen participar deben asegurarse de destacar su experiencia de redacción y edición relevante 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 no soliciten ser escritores 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 de escritura técnicas sólidas y extraordinarias. Los escritores técnicos de Google Season of Docs no reciben asesoramiento, sino que deben ser autoorganizados y motivados para definir su plan para abordar el proyecto de la organización con una mínima orientación 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 de la temporada de Documentos de Google, envíales un correo electrónico a season-of-docs@google.com.

¿Una empresa o consultora de redacción técnica puede participar en la temporada de Documentos de Google?

Sí, una organización puede contratar a una empresa para que haga el trabajo descrito en su propuesta.

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

Enuméralo de la misma forma que con cualquier otro trabajo independiente: "Trabajó como escritor técnico para [nombre del proyecto] como parte del programa Google Season of Docs".

¿Se ofrecen 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 escritores técnicos.

Para administradores de organizaciones de código abierto

¿Cuáles son los requisitos de elegibilidad de 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. No es necesario que el proyecto sea una entidad constituida legalmente. Las organizaciones ya deben haber producido y lanzado software bajo una licencia aprobada de la iniciativa de código abierto y tener al menos dos colaboradores que se desempeñen como administradores de la organización en todo el programa Temporada de Documentos de Google para poder participar en el programa.

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

¿Una “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 por separado para cada suborganización.

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

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

¿Puede un grupo de proyectos de código abierto enviar una propuesta juntos para trabajar en un único 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 pequeños de código abierto que son todos complementos para un proyecto más grande que desean trabajar en una guía práctica conjunta para crear complementos debe elegir una organización para liderar 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 Google Season of Docs?

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

¿Google cubre las tarifas de procesamiento de pagos?

Google no cubre las tarifas por procesamiento de pagos, ya que suelen variar 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 está cubierta. Consulta la guía de recepción de otorgamientos para obtener más información.

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

Te recomendamos consultar Cómo escribir la encuesta de salarios en Documentos y calcular las tarifas por hora. También puedes unirte a Escribe los documentos en Slack y preguntar en el canal de #temporada de documentos para que los escritores técnicos interesados puedan ofertar.

¿Puede mi organización usar el subsidio de la temporada de documentos de Google para pagarle a un colaborador actual?

Sí. Sin embargo, las propuestas de proyectos deben ser para trabajos nuevos (incluidos los trabajos de mantenimiento, las revisiones o las actualizaciones de la documentación existente). No podrás solicitar que se use un otorgamiento para pagar trabajos ya completados.

¿Mi organización puede trabajar con alumnos escritores técnicos?

Puedes elegir que redactores técnicos estudiantes trabajen en tu proyecto. Si decides trabajar con estudiantes, te recomendamos que limites su participación a aquellos estudiantes que cumplan con las siguientes condiciones:

  • Ser mayores de 18 años
  • Están inscritas en un programa o curso de comunicaciones técnicas o de redacción técnica
  • Tener acceso demostrable a 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 a más de un escritor técnico y pagarle, pero todos los escritores técnicos que trabajan con tu organización deben trabajar en el proyecto que propusiste. Trabajar con varios escritores técnicos agregará más complejidad a tu proyecto y requerirá más tiempo de voluntariado y administración.

¿Puede mi organización contratar a una empresa de redacción técnica para que trabaje en nuestro proyecto?

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

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

Se recomienda que los proyectos intenten encontrar un nuevo escritor técnico para completar el 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 tu proyecto no se pudo completar, tu caso práctico debe examinar por qué. Por ejemplo, es posible que hayas descubierto que las herramientas de documentación son muy complicadas y que no obstaculizó la integración de un escritor técnico, o bien que el proyecto implicó probar y actualizar instructivos y requirió mucha experiencia en programación. ¿Qué recomendarías a otros proyectos, según tu experiencia? Incluye esa información en tu caso práctico.

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

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

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

Cuando desarrolles ideas de proyectos, intenta encontrar los proyectos más pequeños que entreguen valor a la organización (pero se pueden expandir si el tiempo lo permite). Cuanto más pequeña es mejor. A la hora de crear tu propuesta de proyecto, te recomendamos que te enfoques en proyectos más pequeños y detallados, en lugar de proyectos más grandes, que son menos especificados. Si tu proyecto requiere mucha experiencia en el ámbito, intenta incluir proyectos en los que alguien podría trabajar sin esa experiencia.

¿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 necesario 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 enviar una solicitud?

Sí, las organizaciones que participaron en programas anteriores de Google Season of Docs pueden volver a enviar una solicitud.

Datos archivados

¿Cómo elimino mi información del archivo de la temporada de documentos de Google?

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