Fase actual:
Desarrollo de la documentación. Consulta el cronograma.
En esta página, se incluyen algunas preguntas que debes tener en cuenta cuando crees un acuerdo con un escritor técnico para Google Season of Docs. El objetivo de esta información no es brindar asesoramiento legal ni ofrecer una lista exhaustiva de todos los puntos posibles que se deben considerar cuando se crean acuerdos de escritura técnica para proyectos de código abierto. Según las necesidades de tu organización o proyecto, te recomendamos consultar a un asesor legal antes de incorporar a un redactor técnico.
Alcance del trabajo
- Crea una lista de los trabajos que abarca tu acuerdo. Sé lo más específico posible. Por ejemplo, en lugar de “Documentación de la API”, haz una lista de los extremos que deben documentarse y la información que debe incluirse, como un comando curl de muestra o una lista de parámetros.
- ¿Cómo sabrás si un contenido está "terminado"?
- Otros aspectos que debes tener en cuenta:
- ¿Quién será el propietario de los derechos de autor de la obra? ¿Con qué licencia se lanzará (estas son diferentes)? ¿Qué crédito recibirá el escritor técnico (mención en el sitio, enumerado como colaborador, etcétera)? ¿Qué pasa si es necesario volver a licenciar el contenido en el futuro? Por ejemplo, si esperas que el escritor técnico firme el Contrato de licencia para colaboradores de tu proyecto de código abierto, debes comunicarlo.
- Si esperas que el escritor técnico participe en varios pases de revisión, escríbelos en voz alta. Por ejemplo, puedes indicar que esperas un primer borrador, luego un segundo pase para abordar problemas técnicos y, luego, un pase final para la revisión de texto.
- Si esperas que el escritor técnico entregue contenido en un formato específico, como Markdown, inclúyelo en tu acuerdo.
- ¿Tu proyecto tiene lineamientos sobre el uso de la IA generativa para crear documentación o código? Asegúrate de compartir esos lineamientos con el escritor técnico.
Compensación
- Acordar con el escritor técnico un calendario de pagos vinculado a fechas firmes y entregas.
- ¿Pagarás un importe por adelantado al comienzo del trabajo?
- ¿Qué sucede si el trabajo no se puede usar o aceptar (porque las prioridades del proyecto cambiaron o porque un revisor abandonó el trabajo, etcétera)? ¿Puedes pagar una "tarifa de eliminación" para compensar el tiempo que dedica el escritor técnico?
- ¿Quién será responsable de las tarifas de conversión de monedas relacionadas con la forma de pago elegida?
Comunicación
- ¿Esperas que el escritor técnico esté disponible para las videollamadas o las reuniones?
- ¿Qué canales de comunicación usarás y cuáles son los tiempos de respuesta esperados? Por ejemplo, si esperas que un escritor técnico responda a los correos electrónicos (o mensajes en Slack) en el plazo de un día, debes hacerlo explícito.
- ¿Con qué miembro del proyecto puede comunicarse el escritor técnico para diferentes preguntas, como problemas de pago, necesidad de revisión, problemas de desbloqueo con herramientas o canales, o algún otro tipo de obstáculos?
- ¿Hay un proceso específico que el escritor deba usar para enviar su trabajo o para obtener comentarios o opiniones?
Herramientas
- ¿Qué herramientas (o versiones de herramientas) debe usar el escritor técnico para crear su trabajo?
- ¿Quién es responsable de ayudar al escritor técnico a establecer, obtener acceso o permisos?
Resolver desacuerdos
- ¿Cómo resolverás los desacuerdos sobre la calidad del trabajo del escritor técnico? ¿Quién tiene la última palabra?
- ¿Cuál sería el proceso para liberar al escritor técnico del proyecto? Por ejemplo, no cumplir con tres plazos seguidos o entregar trabajos de calidad inaceptable. Cuando apliques el proceso, considera incluir de forma explícita los próximos pasos (“Esperamos que se envíe el primer borrador antes del próximo viernes” en lugar de “Envía tu trabajo lo antes posible”).
- Si un escritor técnico necesita abandonar su trabajo, ¿cómo debería comunicarlo? Si es posible, ¿debería avisar, crear un documento de traspaso o tener una llamada de traspaso?
- No olvides considerar las obligaciones del proyecto con el redactor técnico. Por ejemplo, si los mentores de tu proyecto abandonan el proyecto y no se pueden reemplazar, o si las revisiones prometidas no se pueden completar, considera pagar una parte de los fondos restantes al escritor técnico, incluso si el proyecto no se puede completar, para compensar al escritor por su tiempo.
- Indica explícitamente que el redactor técnico está sujeto al Código de Conducta del proyecto y vincula tu proceso de aplicación del Código de Conducta. Te recomendamos que expliques de forma explícita que las infracciones de CoC darán lugar a la rescisión del proyecto y a la pérdida del pago por cualquier trabajo pendiente.