Fase actual:
La temporada de Documentos del programa 2019 finalizó el 6 de marzo de 2020. Consulta el cronograma.
Esta página contiene la guía para los escritores técnicos que participan en Season of Docs.
Introducción
¡Te damos la bienvenida a la temporada de Documentos! En esta guía, se brinda información sobre tu participación en Season of Docs y se brinda ayuda con las actividades que debes realizar en cada fase del programa.
Elegibilidad para participar en Season of Docs
Para participar en Season of Docs como escritor técnico, debe cumplir con los siguientes requisitos:
- Ser mayor de 18 años al momento del registro
- Poder demostrar experiencia previa en escritura técnica mediante el envío de descripciones de funciones y muestras de trabajos
- Aptitud para trabajar en su país de residencia mientras dure el programa
- Ser residente de un país que actualmente no está sujeto a embargos por los Estados Unidos Consulta la información de países y programas de sanciones del Tesoro de EE.UU.
Consulta las condiciones completas de los escritores técnicos.
Tus mentores de código abierto
Los mentores de la temporada de Documentos no son necesariamente escritores técnicos y es posible que tengan poca experiencia en comunicación técnica. Son miembros de la organización de código abierto que conocen el valor de una buena documentación y tienen experiencia en procesos y herramientas de código abierto.
La relación entre tú y tus mentores es una colaboración. Aportas experiencia y habilidades de documentación a la organización de código abierto. Tus mentores aportan su conocimiento sobre código abierto y código. En conjunto, pueden desarrollar documentación técnica y mejorar los procesos del proyecto de código abierto.
Fases de solicitud de organización y anuncio del programa
La fecha de anuncio de la temporada de Documentos es el 11 de marzo de 2019. Las organizaciones de código abierto interesadas pueden enviar una solicitud para participar en Season of Docs entre el 2 y el 23 de abril de 2019. Los administradores del programa de Google publican la lista de organizaciones exitosas el 30 de abril de 2019.
Durante el período entre el anuncio del programa y la publicación de las organizaciones de código abierto participantes, debes estar atento a las noticias. Puedes regresar a este sitio web y mirar las entradas de blog y otras noticias en la Web. Algunas de las organizaciones de código abierto pueden compartir sus ideas incluso durante la fase de solicitud de la organización.
También te invitamos a correr la voz sobre la temporada de Documentos y por qué te interesa el programa. Revisa el material promocional para obtener ideas y gráficos.
Fase de exploración del escritor técnico
La fase de exploración del escritor técnico va del 30 de abril al 28 de mayo de 2019. Durante este período, puedes explorar la lista de organizaciones participantes y sus ideas de proyectos.
Cuando encuentres uno o más proyectos que te interesen, debes comunicarte directamente con la organización de código abierto correspondiente para analizar las ideas de proyectos.
| Tus tareas como escritor técnico durante esta fase | |
|---|---|
|
Explora la lista de organizaciones de código abierto que participan y sus ideas para proyectos. |
Examina la lista para buscar una organización de código abierto con la que te gustaría trabajar. Revisa los proyectos de redacción técnica que propusieron las organizaciones y decide qué proyectos son más adecuados para ti. Puedes postularte a más de una organización. En esta etapa de Season of Docs, es aconsejable explorar más de una opción. El proceso de selección final acepta solo un proyecto por escritor técnico. |
|
Debatir ideas de proyectos con organizaciones de código abierto. |
Puedes analizar ideas de proyectos con cualquiera de las organizaciones participantes. Para comunicarte, usa la dirección de correo electrónico de la organización que aparece en la lista de organizaciones participantes. Los primeros debates te ayudan a elaborar una buena propuesta de proyecto para enviarla a los administradores del programa de Google durante la fase de solicitud del escritor técnico. Las ideas iniciales del proyecto pueden provenir de la lista de ideas que propuso la organización. También puedes proponer tus propias ideas. |
Fase de postulación del escritor técnico
La fase de solicitud del escritor técnico dura del 29 de mayo de 2019 al 28 de junio de 2019. Durante este período, puedes enviar una solicitud para participar en la temporada de Documentos. Los administradores del programa de Google reenvían los detalles relevantes de tu solicitud a la organización de código abierto que elijas. Los administradores y mentores de la organización de código abierto luego seleccionan los proyectos que quieren mencionar.
| Tus tareas como escritor técnico candidato durante esta fase | |
|---|---|
|
Envía tu solicitud para participar en Season of Docs. |
Envía tu solicitud para la temporada de Documentos antes del 28 de junio de 2019. Ya no se cerraron las postulaciones para escritores técnicos de la temporada 2019 de Documentos. |
Fase de vinculación con la comunidad
La fase de vinculación con la comunidad se extiende del 7 de agosto al 1 de septiembre de 2019. Durante este período, los mentores de código abierto te ayudarán a familiarizarte con la comunidad y el proyecto de código abierto.
| Tus tareas como escritor técnico durante esta fase | |
|---|---|
|
Configura los canales de comunicación. |
Ponte en contacto con tus mentores en la organización de código abierto con la que elegiste trabajar. Asegúrate de tener una manera confiable de comunicarte directamente con tu mentor y con los administradores de la organización. Estos últimos son miembros de la organización de código abierto que actúan como contacto principal de la temporada de Documentos de su organización. |
|
Participa en el proyecto de código abierto y la comunidad. |
Hazle preguntas a tu mentor sobre las herramientas y los procesos que usa la organización de código abierto. Preséntate en las listas de distribución, el chat, el canal de Slack y cualquier otro canal de comunicación compartido de la comunidad de código abierto. |
|
Comprender el producto como un todo |
Pídele a tu mentor que explique el producto (en especial desde el punto de vista conceptual) que vas a documentar. Analiza el público de la documentación en detalle. |
|
Establece objetivos y expectativas. |
Trabaja con tu mentor para definir mejor los objetivos de tu proyecto de escritura técnica y establecer expectativas para ambos lados. Establecer estos objetivos y expectativas ahora es una buena manera de garantizar el éxito de tu proyecto. |
Fase de desarrollo del documento
La fase de desarrollo de documentos abarca del 2 de septiembre de 2019 al 22 de noviembre de 2019. (La fecha de finalización es diferente para los proyectos de larga duración). Durante este período, trabajas en tu proyecto con una estrecha colaboración con tus mentores.
| Tus tareas como escritor técnico durante esta fase | |
|---|---|
|
Trabaja con tu mentor para completar tu proyecto. |
Trabaja en estrecha colaboración con tu mentor para completar el proyecto. Sigue los procedimientos de la comunidad de código abierto para solicitar revisiones de la documentación resultante y enviar las actualizaciones al repositorio de código abierto. Por ejemplo, los proyectos de código abierto alojados en GitHub agregan o actualizan archivos mediante la creación de una solicitud de extracción para su revisión y envío. |
|
Informa cualquier inquietud al administrador de la organización. |
Si tienes alguna inquietud sobre la comunicación con tus mentores o tienes algún otro problema que pueda afectar la finalización exitosa de tu proyecto, avísale al administrador de la organización de código abierto. |
|
Completar las encuestas de los administradores del programa de Google |
Los administradores del programa de Google pueden enviar una encuesta a mitad del proyecto para evaluar el progreso. Completa la encuesta y envía tus respuestas a los administradores del programa de Google según las instrucciones que figuran en el documento de la encuesta. |
Fase de finalización y evaluación del proyecto
La fase de finalización del proyecto se ejecuta del 25 al 29 de noviembre de 2019, y la fase de evaluación se extiende del 25 de noviembre al 6 de diciembre de 2019. (Las fechas son diferentes para los proyectos de larga duración). Durante el período de finalización del proyecto, envías el informe del proyecto, también llamado productos finales del trabajo. Durante la fase de evaluación, debes enviar la evaluación de tus mentores y tu experiencia como participante de Season of Docs.
| Tus tareas como escritor técnico durante esta fase | |
|---|---|
|
Escribe el informe del proyecto. |
Escribe el informe del proyecto (a veces llamado producto de trabajo). El informe del proyecto incluye una descripción del trabajo que realizaste durante la temporada de Documentos y los vínculos relevantes. Cómo crear el informe del proyecto Finalizó la fase de finalización de proyectos de la temporada 2019 de Documentos. |
|
Pídele a tu mentor que revise tu informe del proyecto. |
Tu mentor puede tener información valiosa sobre cómo describir tus logros. Además, es útil lograr una comprensión compartida del estado del proyecto en esta etapa, antes de que tu mentor marque el proyecto si se completó correctamente o no. |
|
Finalizar el informe del proyecto |
Finaliza el informe de tu proyecto antes del 28 de febrero de 2020 a las 6:00 p.m. UTC. El formulario se puede editar, pero debes enviar la versión final antes de la fecha indicada. Finalizó la fase de finalización de proyectos de la temporada 2019 de Documentos. |
|
Escribe y envía una evaluación sobre tu mentor y tu experiencia con Season of Docs. |
Completa y envía tu evaluación antes del 28 de febrero de 2020 a las 6:00 p.m. UTC. Evaluaciones de escritores técnicos Finalizó la fase de finalización de proyectos de la temporada 2019 de Documentos. |
Proyectos de larga duración
En el caso de los proyectos de escritura técnica de longitud estándar en Season of Docs, la fase de desarrollo de documentos abarca del 2 de septiembre de 2019 al 22 de noviembre de 2019. Sin embargo, algunos escritores técnicos pueden solicitar un proyecto de larga duración con asesoramiento de la organización de código abierto. En el caso de un proyecto de larga duración, la fase de desarrollo de documentos se extiende del 2 de septiembre de 2019 al 21 de febrero de 2020.
El período de finalización y evaluación para los proyectos de larga duración es del 24 al 28 de febrero de 2020.
Tus tareas y responsabilidades son las mismas que se describen en esta página para los proyectos de escritura técnica de longitud estándar, excepto que las fechas de finalización y evaluaciones de proyectos son posteriores.
Información relacionada
- Consulta el cronograma de la temporada de Documentos.
- Para obtener más información sobre tu relación con la organización de código abierto que elegiste, lee las responsabilidades de los mentores y administradores de la organización y los lineamientos para mentores sobre cómo trabajar con un escritor técnico.