Fase actual:
La temporada de Documentos del programa 2019 finalizó el 6 de marzo de 2020. Consulta el cronograma.
Esta página contiene sugerencias para escritores técnicos sobre cómo completar las partes clave de una solicitud para participar en Season of Docs. Esta información te ayuda a comprender qué factores pueden tener en cuenta las organizaciones de código abierto cuando seleccionan los proyectos de escritura técnica sobre los que quieren ser mentor durante Season of Docs.
Introducción
Por lo general, los lineamientos que se indican a continuación se aplican a la temporada de Documentos. Cada organización individual de código abierto puede tener criterios de evaluación específicos. Puedes comunicarte con cualquiera de las organizaciones participantes antes de enviar tu solicitud para analizar sus requisitos y planificar tu propuesta de proyecto. Consulta la fase de exploración de escritores técnicos que se describe en la guía de escritores técnicos.
El formulario de solicitud
El formulario de solicitud está disponible en la guía para escritores técnicos durante la fase de solicitud de escritor técnico.
Después de enviar el formulario, puedes seguir actualizando su información hasta el final de la fase de solicitud del escritor técnico (28 de junio de 2019).
Información personal
El formulario de solicitud solicita la siguiente información personal:
Su nombre: Proporcione su nombre completo. Season of Docs no compartirá este nombre con las organizaciones de código abierto ni lo publicará en el sitio web.
Un nombre visible de tu elección: Proporciona el nombre que deseas usar como identificador público durante tu participación en Temporada de Documentos. Te recomendamos que no uses tu nombre completo y real como nombre visible. Season of Docs compartirá tu nombre visible con la organización de código abierto que indiques en tu formulario de postulación. La temporada de Documentos publicará tu nombre visible en el sitio web en la lista de proyectos de escritura técnica aceptados.
Tu dirección de correo electrónico: Proporciona la dirección de correo electrónico asociada con tu Cuenta de Google. Para participar en Season of Docs, necesitas una Cuenta de Google. Puedes usar una dirección de correo electrónico que no sea de Gmail con una Cuenta de Google. Consulta este artículo de ayuda). Season of Docs usa tu dirección de correo electrónico para comunicarse contigo y poner a tu disposición los recursos del sitio web. Season of Docs compartirá esta dirección de correo electrónico con la organización de código abierto que indiques en el formulario de solicitud. La temporada de Documentos no publicará esta dirección de correo electrónico en el sitio web.
Consulta a continuación para ver un resumen de cómo Season of Docs usa la información de tu formulario de solicitud.
Información sobre tu experiencia de escritura técnica
Cuando los mentores de código abierto y los administradores de la organización examinan la propuesta de un proyecto, se interesan en tu experiencia de escritura técnica. Puedes proporcionar detalles en el formulario de la siguiente manera:
Experiencia de escritura técnica más reciente: Hasta tres entradas en las que puedas enumerar tus funciones de escritura técnica o experiencia laboral más recientes. Si tienes experiencia en documentación de código abierto, inclúyela aquí también. Resume tu función, las responsabilidades de la función y el trabajo que completaste. Puedes proporcionar fechas cuando corresponda.
Un vínculo a tu currículum: (opcional) Es la URL de una versión de acceso público de tu currículum o currículum vitae (CV).
Un vínculo a tus muestras de trabajo: (opcional) Corresponde a la URL de un portfolio de muestras de escritura de acceso público o vínculos individuales a ejemplos de tu trabajo.
Cualquier otra cosa que quieras agregar: (opcional) Toda la información que quieras agregar esta aplicación. Por ejemplo, tu interés en la documentación técnica, por qué deseas participar en Season of Docs o cualquier otra experiencia relevante.
Propuesta de proyecto
La propuesta de tu proyecto es un resumen del trabajo de documentación que te gustaría completar mientras trabajas con la organización de código abierto que elegiste durante la temporada de documentos.
Puedes enviar un máximo de tres propuestas de proyectos. Todas tus propuestas de proyectos deben estar en el mismo formulario de solicitud.
Dedica tiempo a tu propuesta de proyecto y ten en cuenta las siguientes pautas.
Trabajo preparatorio:
Revisa la lista de organizaciones de código abierto que participan y elige una o más organizaciones de tu interés. Echa un vistazo a las ideas de proyecto propuestas por cada una de las organizaciones de código abierto que elegiste.
Si la organización que te interesa no sugirió ninguna idea, puedes examinar la lista genérica de ideas de proyectos y basar tu idea en una de ellas. También puedes elegir tener tu propia idea, ya sea que la organización haya publicado ideas o no.
Comunícate con una o más de las organizaciones participantes para analizar las ideas del proyecto. 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 armar una buena propuesta de proyecto.
Tu propuesta de proyecto en el formulario de solicitud:
Nombre de la organización de código abierto: Ingresa el nombre de la organización de código abierto con la que deseas trabajar durante la temporada de Documentos. Debe ser una de las organizaciones participantes que se muestran en el sitio web de Season of Docs.
Nombre del proyecto de código abierto: Es el nombre del proyecto de código abierto en el que quieres trabajar durante la temporada de Documentos. El proyecto debe pertenecer a una de las organizaciones participantes que se muestran en el sitio web de Season of Docs. En algunas organizaciones, el nombre de la organización y el del proyecto pueden ser los mismos.
El nombre del proyecto de redacción técnica que se propone. Proporciona un título corto y descriptivo que resuma el objetivo principal del trabajo que propones.
Una descripción detallada. Proporciona tantos detalles como sea posible en la descripción del proyecto de escritura técnica que propones. Es correcto ingresar varios párrafos en el campo de descripción. Estas son algunas ideas sobre lo que debes incluir:
- Proporciona detalles sobre la documentación que propones crear o actualizar. Si planeas actualizar un documento o sitio existente, incluye un vínculo y describe las actualizaciones propuestas. Si propones un documento o sitio nuevos, describe el contenido y el público.
- Explica por qué propones la nueva documentación o las actualizaciones.
- Si hablaste del proyecto con alguien de la organización de código abierto, incluye un resumen del resultado de esos debates.
- Presta atención al lenguaje y al estilo de tu propuesta. La organización de código abierto puede usarlos como un factor para evaluar la propuesta.
- No proporciones un vínculo a la descripción del proyecto. La descripción debe incluir todos los detalles definitivos de tu proyecto. La organización de código abierto debe poder realizar una selección en función del contenido del formulario de solicitud en lugar del contenido guardado en otro lugar. Si necesitas vincular a otro contenido que complemente la descripción, no hay problema, pero ten en cuenta que solo el contenido del formulario de solicitud se usa para la selección de proyectos.
Otros campos importantes del formulario de solicitud
A continuación, se presentan lineamientos sobre otra información clave que debes proporcionar en el formulario de solicitud:
Elegir un proyecto de duración estándar o de larga duración: El período estándar para la fase de desarrollo de documentos de la temporada de Documentos es de tres meses. Si tu proyecto requiere un período más largo, debes indicarlo en el formulario de solicitud después de consultar con la organización de código abierto que elijas. Consulta la descripción de proyectos de larga duración.
Aceptar el subsidio de la temporada de Documentos: Esta temporada paga una suma de dinero a los escritores técnicos que completan con éxito sus proyectos, siempre que el escritor técnico quiera aceptar el subsidio. Consulta la información sobre los recargos de escritores técnicos. El estipendio es opcional. Si no quieres recibir el subsidio, indica tu elección en el formulario de solicitud.
De qué manera Season of Docs utiliza la información de su formulario de solicitud
En esta sección, se resume la forma en que Season of Docs usa la información de tu formulario de solicitud. En las secciones anteriores de esta página, se describen los campos clave en detalle.
La tabla enumera los campos clave. Para cada campo, la tabla indica si la Temporada de Documentos tiene las siguientes características:
- Pasa la información a la organización de código abierto que especificaste en el formulario de aplicación.
- Publica la información en la lista de proyectos de escritura técnica aceptados en el sitio web de la temporada de Documentos.
| Información del formulario | ¿Se comparte con la organización de código abierto? | ¿Se muestra en el sitio web de la temporada de Documentos? |
|---|---|---|
| Nombre completo | ||
| Nombre visible | ||
| Dirección de correo electrónico | ||
| Experiencia reciente en la escritura técnica | ||
| Vínculo al currículum o CV | ||
| Vínculo a muestras de trabajo | ||
| Cualquier otro elemento que desees agregar | ||
| Nombre del proyecto o de la organización con código abierto | ||
| Nombre y descripción del proyecto de escritura técnica | ||
| Proyecto de larga duración o de longitud estándar | ||
| Aceptación del subsidio |
Clave de los símbolos utilizados en la tabla anterior:
| Símbolo | Significado del símbolo |
|---|---|
| Sí | |
| No |
Notas
A continuación, se incluyen algunos puntos más para tener en cuenta:
Envío de varias propuestas de proyectos: Puedes enviar más de una propuesta de proyecto, pero Season of Docs solo acepta una propuesta por escritor técnico. Solo puedes enviar un formulario de solicitud. El formulario admite hasta tres propuestas de proyectos.
Cantidad total de proyectos de redacción técnica del programa: La temporada de Documentos solo puede aceptar una cantidad máxima determinada de proyectos de redacción técnica en total. Consulta cómo funciona la asignación de ranuras.
Guías relacionadas
Consulta las sugerencias para mentores sobre cómo evaluar las propuestas técnicas de los escritores. Comprender los criterios de selección de los mentores te ayuda a crear una propuesta con más probabilidades de tener éxito.
Para obtener información de procedimiento sobre cuándo y cómo enviar tu solicitud de Season of Docs, consulta la guía para escritores técnicos.