Ideas del proyecto

Fase actual:
La temporada de Documentos del programa 2019 finalizó el 6 de marzo de 2020. Consulta el cronograma.

Las ideas de proyectos son sugerencias de una organización de código abierto para proyectos que un escritor técnico puede realizar en colaboración con un mentor durante Season of Docs.

La información de esta página está destinada a administradores y mentores de organizaciones de código abierto que están preparando su lista de ideas para proyectos. La información también es útil para los escritores técnicos como referencia para la participación de las organizaciones en Season of Docs.

Proyectos de ejemplo

A continuación, se presentan algunas ideas del tipo de proyecto que puede abordar un escritor técnico:

  • Crea un sitio de documentación en una plataforma que decidan el escritor técnico y el mentor 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. 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.

Las ideas anteriores varían intencionalmente en alcance y tamaño. El tiempo que toma cualquier proyecto depende de varios factores, como el tamaño del conjunto de documentos, la complejidad del producto, la experiencia del escritor técnico y de los mentores de código abierto, las herramientas y los procesos que ofrece el proyecto de código abierto, entre otros.

El objetivo de la lista anterior es ayudarte a comenzar. También puedes proponer otros tipos de proyectos.

Publica tu lista de ideas de proyectos

Debes publicar las ideas de tus proyectos en una página web pública, en una entrada de blog o en algún otro documento visible de forma pública.

Tu página de ideas de proyectos debe incluir:

  • Información sobre tu organización de código abierto:

    • Nombre de la organización.
    • Descripción de la organización.
    • Un vínculo a tu repositorio o sitio web de código abierto.
    • Una dirección de correo electrónico para comunicarse con tu organización sobre Season of Docs (opcional) Debe ser la misma que la dirección de correo electrónico que incluyas en el formulario de solicitud de tu organización para la temporada de Documentos.
    • (Opcional) Información sobre la administración de la organización y los mentores, como sus nombres visibles. Estos deben ser los mismos que los nombres visibles que incluyas en el formulario de solicitud de la temporada de Documentos de tu organización.

  • Un anuncio de que tu organización solicita participar en la temporada de Documentos de este año. En la página de promoción y prensa, se incluyen logotipos y otro contenido que puedes usar cuando te refieras a la temporada de Documentos.

  • Las ideas de tu proyecto, incluida la información que se describe a continuación para cada idea de proyecto

Cuando crees la solicitud de Season of Docs de tu organización, deberás incluir un vínculo a la página de ideas para tu proyecto.

Información en cada idea de proyecto

Cada idea de proyecto debe incluir, al menos, la siguiente información:

  • Nombre del proyecto: Elige un título conciso pero descriptivo.
  • Descripción: Una descripción más larga del trabajo de documentación requerido. Describe tu idea inicial en detalle. Ofrece oportunidades a cualquier escritor técnico interesado para ampliar o perfeccionar la idea.

  • Material relacionado:

    • Vínculo al proyecto de código abierto que necesita documentación.
    • Si propones un proyecto de escritura técnica que implica actualizaciones a un conjunto de documentación existente, vincúlalo a ese conjunto.
    • Si propones un instructivo o un conjunto de guías prácticas, describe las características o los casos prácticos que necesitan documentación.
    • Si propones una guía para colaboradores, incluye vínculos a cualquier archivo README existente o a otro material relevante, si corresponde. Si todavía no hay nada disponible, está bien decirlo.
    • Incluye enlaces a documentación similar en otros proyectos, si corresponde.

Importancia de las ideas del proyecto

Tus ideas de proyecto son importantes de varias maneras:

  • Trabajar con las ideas ayuda a tu organización a formular las tareas de documentación necesarias y a prepararse para trabajar con un escritor técnico.
  • Las ideas de proyectos les brindan a los administradores del programa de Google una indicación del tipo de trabajo que abordará un escritor técnico cuando entabla una relación de asesoramiento con tu organización. Los administradores del programa de Google utilizan las ideas de proyecto para juzgar el compromiso de la organización con la participación en Season of Docs y para asesorar a un escritor técnico durante el programa.
  • Las ideas de proyectos atraen a escritores técnicos interesados a tu organización. Pueden usar tus proyectos sugeridos como base para sus propias propuestas de proyectos.
  • En la página de promoción y prensa, se incluyen logotipos y otro contenido que puedes usar cuando te refieras a la temporada de Documentos.
  • En este video de PyCon Australia 2017, se ofrecen sugerencias sobre cómo organizar la documentación para que a las personas les resulte útil: Lo que nadie te cuenta sobre la documentación de Daniele Procida.