Preguntas frecuentes

Fase actual:
Datos anunciados cronograma.

General

¿Es Season of Docs un programa de reclutamiento?

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

¿En qué se diferencia el programa actual de la temporada de Documentos 2019 y 2020?

La temporada actual de Documentos tiene cambios significativos con respecto a años anteriores, incluidos los siguientes:

  • Los escritores técnicos ya no aplican a través de Google para vincularse con organizaciones.
  • Las organizaciones envían propuestas de proyectos como parte de su solicitud, incluidos un presupuesto y las métricas propuestas
  • Las organizaciones aceptadas reciben subsidios y se usan para pagarles a escritores técnicos
  • Las organizaciones envían evaluaciones finales y casos de éxito

¿Por qué Season of Docs realizó estos cambios?

En Google, nuestra misión es organizar la información del mundo para que sea accesible y útil para todos. Con un nuevo enfoque en Season of Docs para enfatizar el aprendizaje sobre prácticas de documentación eficaces en código abierto, esperamos tener un mayor impacto a largo plazo.

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

Consulta nuestra lista completa de ideas de proyectos. También puedes comunicarte con la comunidad de escritura técnica (prueba el canal #season-of-docs en Escribe los documentos en Slack o en tus canales de redes sociales para pedir ayuda o hacer 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 el escritor técnico y la organización de código abierto decidan, 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. Como resultado, hay 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 comenzar a trabajar en el proyecto de código abierto, así como 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.

¿Es un video un proyecto posible para la temporada de Documentos?

Sí. Asegúrate de que los requisitos de video estén bien definidos, y ten en cuenta que producir un video de alta calidad requiere mucho tiempo y recursos.

¿Es una auditoría de documentación un proyecto razonable para la temporada de Documentos?

Una auditoría de documentación es un gran proyecto para la temporada de Documentos. 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, 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 organizaciones y escritores técnicos las usen?

La temporada de Documentos tiene un repositorio de GitHub con una plantilla y una lista de tareas para realizar auditorías de documentación. Esperamos agregar otras plantillas a medida que se crean.

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

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

No. En ocasiones, los proyectos no salen como se esperaba o los requisitos cambian. 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 usar la documentación ni otros materiales.

¿Dónde tiene lugar la temporada de Documentos?

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

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

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. Únete al grupo para recibir actualizaciones por correo electrónico.

¿Puedo agregar el cronograma de la temporada de Documentos a mi calendario?

Sí, puedes agregarla mediante este vínculo.

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

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

¿Cómo organizo u organizo una reunión informativa o una reunión de la temporada de Documentos de Google?

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

¿Hay estadísticas que puedas compartir sobre las temporadas de Documentos de 2019 y 2020?

Sí, los resultados de la temporada de documentos del programa de 2019 se pueden consultar aquí, y los resultados del programa de 2020 están disponibles aquí.

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

No, debido a restricciones de envío internacionales, ya no podremos proporcionar camisetas a los participantes que completen correctamente su proyecto de la temporada de Documentos.

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

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

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

¿Cómo puedo ser mentor de Season of Docs?

La temporada de Documentos 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 Season of Docs, te recomendamos trabajar con los administradores de tu organización como voluntario.

¿Es temporada de Documentos como Google Summer of Code?

No. Season of Docs está diseñada para personas con cierta experiencia en redacción técnica; no está diseñado como un programa de tutoría como Google Summer of Code.

Para escritores técnicos

¿Cuándo pueden postularse los escritores técnicos para la temporada de Documentos?

La temporada de Documentos no cuenta con una postulación formal y técnica de escritor. Si deseas participar en Season of Docs como escritor técnico, comunícate directamente con las organizaciones de código abierto mediante las instrucciones que se encuentran en la página del programa Season of Docs. También puedes expresar tu interés si te agregas al Directorio de escritores técnicos de la temporada de Documentos. Consulta la guía para escritores técnicos a fin de obtener más información.

¿Qué herramientas y frameworks de documentación debo conocer para participar en la temporada de Documentos?

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 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 necesario que tengas conocimientos detallados sobre plataformas de documentación específicas antes de comenzar tu proyecto de la temporada de Documentos.

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 Leer 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 un buen lugar para brindar consejos de sonido al proyecto de código abierto que elijas.

¿Qué lenguajes de programación debo conocer para participar en los proyectos de la temporada de Documentos?

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.

¿Pueden los escritores técnicos que ya trabajan en un proyecto de código abierto seguir haciéndolo como parte de la temporada de Documentos?

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 recomienda contar con experiencia o capacitación previa en redacción técnica, pero no esencial. Cuando envías una declaración de interés a una organización, puedes describir tu experiencia o capacitación en redacción técnica. Deberías 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 la temporada de proyectos de Documentos.

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

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 provienen 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 enviarlas. Consulta la guía para crear tu declaración de interés.

¿Cuánto tiempo lleva participar en Documentos durante la temporada?

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 acordaste con la organización. Antes de comprometerte, debes evaluar el proyecto y analizar una estimación de tiempo con la organización de código abierto.

¿Puedo enviar una solicitud de una organización para crear documentación para un proyecto de código abierto como persona? 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 formo parte del proyecto ni colabora en él.

No, solo debes enviar una propuesta si puedes recibir fondos en nombre del proyecto de código abierto. Te recomendamos que te comuniques con el proyecto y colabores en una propuesta de solicitud.

Soy estudiante, ¿puedo participar en la temporada de Documentos? ¿Esta temporada de Documentos me enseñará a ser una escritora técnica?

Los estudiantes son aptos para trabajar con organizaciones aceptadas, pero Season of Docs no tiene como objetivo enseñar habilidades de escritura técnica. Esperamos 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 escritura y edición relevante cuando se comunican con las organizaciones y los proyectos interesados.

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

Aunque, por el momento, esto no va en contra de las reglas, sugerimos que los estudiantes aceptados en Google Summer of Code no se postulen para ser escritores técnicos de Season of Documentos. Los estudiantes deben concentrarse en el trabajo de Google Summer of Code en lugar de postularse a Season of Docs.

Además, Season of Docs no está pensada para principiantes, sino para personas que ya tienen habilidades y experiencia de escritura técnicas sólidas y superiores. Los escritores técnicos de Season of Docs no reciben asesoramiento, sino que deben ser autoorganizados y motivados para definir su plan de 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 de la temporada de Documentos si tengo más preguntas o inquietudes?

Puedes comunicarte con los administradores del programa de Google de la temporada de Documentos por correo electrónico a season-of-docs@google.com.

¿Una empresa o consultora de redacción técnica puede participar en Season of Docs?

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 en mi currículum?

Enuméralo como lo harías con cualquier otro trabajo independiente; p.ej., "Trabajé como escritor técnico para [nombre del proyecto] como parte del programa Temporada de Documentos".

¿Se entregan certificados de finalización por participar en la temporada de Documentos?

No podemos enviar certificados ni confirmaciones de participación en el proyecto a los escritores 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. No es necesario que el proyecto sea una entidad con incorporación legal. Las organizaciones ya deben haber producido y lanzado software bajo una licencia aprobada por 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 de Season of Docs para participar en el programa.

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

¿El término “organización” es equivalente 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 una de ellas.

¿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 de código abierto individuales), cada proyecto debe enviar su propia solicitud, incluso si la organización general se encarga 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 el apoyo 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 Season of Docs?

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 de procesamiento de pagos?

Google no cubre las tarifas por 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 host fiscal, esa tarifa también está cubierta. Consulta la guía sobre la recepción de otorgamientos para obtener más información.

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

Te recomendamos consultar la encuesta salarial de Documentos y calcular las tarifas por hora. También puedes unirte a Escribe los documentos en Slack y solicitar a los escritores técnicos interesados que oferten en el canal #season-of-docs.

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

Sí. Sin embargo, las propuestas de proyectos deben ser para trabajos nuevos (incluidos los trabajos de mantenimiento, la revisión o las actualizaciones de la documentación existente). No puedes solicitar un subsidio para pagar trabajos ya completados.

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

Puedes elegir que escritores técnicos estudiantes trabajen en tu proyecto. Si eliges trabajar con estudiantes, te recomendamos que limites la participación a aquellos que cumplan con los siguientes requisitos:

  • Ser mayor de 18 años
  • Están inscritos en un programa o curso de redacción técnica o de comunicaciones técnicas
  • Tener acceso demostrable a mentorí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 escritores técnicos agregará más complejidad a tu proyecto y requerirá más tiempo de voluntario y administración.

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

Sí, es posible que tu organización contrate 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 se retiró antes del final del programa. ¿Aún se cumplen los requisitos para recibir los fondos restantes?

Te recomendamos que intentes encontrar un nuevo escritor técnico para completar tu 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, se espera que tu caso práctico analice por qué. Por ejemplo, es posible que hayas notado que tus herramientas de documentación son muy complicadas y que demostraron ser una barrera para integrar a un escritor técnico, o que tu proyecto implicó probar y actualizar instructivos y requirió una amplia 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 una organización antes de la fecha límite de envío?

Lamentablemente, no podemos enviar 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 aporten valor a la organización (pero se pueden expandir si el tiempo lo permite). Cuanto más pequeño, mejor. Al 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 campo, intenta incluir proyectos en los que podría trabajar alguien sin esa experiencia.

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

Sí. La temporada de Documentos y el verano de código de Google son programas separados. No hay problema si tienes el ancho de banda necesario para participar en ambos programas.

Nuestra organización participó en la temporada anterior de programas de Documentos. ¿Se puede volver a enviar una solicitud?

Sí, las organizaciones que participaron en la temporada anterior de programas de Documentos pueden volver a enviar una solicitud.

Datos archivados

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

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