Fase actual:
El programa de la Temporada de documentos de 2021 finalizó el 14 de diciembre de 2021. Consulta el cronograma.
Estos son algunos lineamientos para ayudar a las organizaciones de código abierto a trabajar de manera eficaz con escritores técnicos.
Presenta al escritor técnico al mundo del código abierto y a tu comunidad.
- Dale al escritor técnico una “visita guiada” por tu comunidad. ¿Dónde pueden hacer preguntas? ¿A qué reuniones habituales debe asistir o a qué listas de distribución debe unirse? ¿Qué cuentas necesitan (GitHub, Discord, Slack)? Asegúrate de que comprendan el código de conducta de tu proyecto y sepan cómo informar cualquier problema. Asegúrate de que el escritor técnico comprenda la licencia de tu proyecto y cumpla con los requisitos de otros empleadores relacionados con la firma de CLC, DCO y demás acuerdos.
- Si es posible, preséntale a algunas personas que estén en zonas horarias superpuestas y que puedan responder rápidamente las preguntas sobre la comunidad o el proyecto.
- Si puedes, envíales algunos artículos promocionales del proyecto.
Ayudar al escritor técnico a usar las herramientas y procesos involucrados en contribuir a tu proyecto
- Si tus procesos no están bien documentados, programa un momento para explicarle al escritor técnico su primera contribución, problema o solicitud de extracción. ¿Qué plantillas o etiquetas deberían usar? ¿Quién debe revisar su contribución y cómo y cuándo debe hacer un seguimiento de las revisiones? Si su trabajo incluye muestras de código, ¿cómo se pueden probar? ¿Qué necesitan saber sobre tu proceso o lanzamientos de CI/CD?
Ayuda al escritor técnico a comprender tu proyecto y sus usuarios
- Explica tu proyecto en detalle para que el redactor técnico comprenda de forma clara el concepto del producto. Esto puede ayudar al escritor técnico a sentirse más seguro y tener más autoridad en su redacción para el proyecto.
- Describe las necesidades de las personas que usan el proyecto. Sé lo más específico posible, no solo "desarrolladores", sino "desarrolladores que crean sitios web" y "desarrolladores que programan robots industriales".
- Pídele al escritor técnico que se comunique con los expertos en la materia necesarios. Es decir, los desarrolladores u otros colaboradores responsables de los aspectos de tu proyecto que cubrirá la documentación.
- Asegúrate de que el redactor técnico obtenga el tiempo y los recursos que necesita de los expertos en el tema y de cualquier otro miembro de la comunidad.
Haz preguntas.
- Es posible que tu comunidad o proyecto no haya trabajado antes con escritores técnicos o colaboradores de documentación. ¡Aprovecha la oportunidad de aprender mientras compartes lo que sabes! Pide comentarios sobre tus procesos y herramientas. Es probable que el escritor técnico tenga algunas sugerencias para mejorar.