Fase actual:
Datos anunciados
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 el mundo del código abierto y a tu comunidad
- Ofrece al escritor técnico una "visita guiada" por tu comunidad. ¿Dónde puede hacer preguntas? ¿A qué reuniones regulares deben asistir o a qué listas de distribución deben 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 todos los requisitos de otros empleadores en cuanto a la firma de CLC, DCO u otros acuerdos.
- Si es posible, preséntales a algunas personas en zonas horarias superpuestas que puedan responder rápidamente a las preguntas sobre la comunidad o el proyecto.
- Si puedes, envíales algunos productos promocionales del proyecto.
Ayuda al escritor técnico a usar las herramientas y los procesos involucrados en contribuir a tu proyecto
- Si tus procesos no están bien documentados, programa un horario 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 necesita 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 el proceso de CI/CD o las versiones?
Ayuda al escritor técnico a comprender tu proyecto y a sus usuarios
- Explica tu proyecto en detalle para que el escritor técnico obtenga una sólida comprensión conceptual del producto. Esto puede ayudar al escritor técnico a sentirse más seguro y a ser más autorizado a la hora de redactar el proyecto.
- Describir las necesidades de las personas que usan el proyecto. Debes ser tan específico como puedas: no solo "desarrolladores", sino también "desarrolladores de sitios web" y "desarrolladores que programan robots industriales".
- Poner al escritor técnico en contacto con los expertos en la materia necesarios Es decir, los desarrolladores u otros colaboradores del proyecto responsables de los aspectos de tu proyecto que abarcará la documentación.
- Asegúrate de que el escritor técnico obtenga el tiempo y los recursos que necesita de los expertos en la materia 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 para 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.