Crear un acuerdo técnico de escritor

Fase actual:
Casos de éxito publicados. 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 la Temporada de Documentos de Google. No se trata de un asesoramiento legal ni de una lista exhaustiva de todos los puntos posibles que se deben tener en cuenta cuando se crean acuerdos de redacción técnica para proyectos de código abierto. Según las necesidades de tu organización o proyecto, te recomendamos que consultes a tu propio asesor legal antes de incorporar a un escritor técnico.

Alcance del trabajo

  • Crea una lista del trabajo que cubre 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 se deben documentar y qué información se debe incluir, 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á (son diferentes)? ¿Qué crédito recibirá el escritor técnico (mención en el sitio, aparecer como colaborador, etcétera)? ¿Qué sucede si el contenido necesita una nueva licencia en el futuro? Por ejemplo, si esperas que el redactor técnico firme el Acuerdo de Licencia para Colaboradores de tu proyecto de código abierto, debes comunicarlo.
    • Si esperas que el escritor técnico participe en varios procesos de revisión, indícalo. Por ejemplo, puedes indicar que esperas un primer borrador, luego un segundo pase para abordar los problemas técnicos y, por último, un pase final para la revisión.
    • Si esperas que el redactor técnico entregue contenido en un formato específico, como Markdown, inclúyelo en el acuerdo.
    • ¿Tu proyecto tiene lineamientos para el uso de la IA generativa para crear documentación o código? Asegúrate de que esos lineamientos se compartan con tu escritor técnico.

Compensación

  • Llegar a un acuerdo con el escritor técnico sobre un cronograma de pagos vinculado a fechas y entregas firmes
  • ¿Pagarás un importe por adelantado al comienzo del trabajo?
  • ¿Qué sucede si el trabajo no se puede usar o aceptar (porque cambiaron las prioridades del proyecto o porque un revisor abandonó el proyecto, etcétera)? ¿Puedes pagar una “tarifa de cancelación” para compensar el tiempo que dedicó el escritor técnico?
  • ¿Quién será responsable de las tarifas de conversión de moneda relacionadas con la forma de pago elegida?

Comunicación

  • ¿Esperas que el redactor técnico esté disponible para videollamadas o 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 los correos electrónicos (o los mensajes en Slack) en un día, explícalo de forma clara.
  • ¿Con quién del proyecto puede comunicarse el redactor técnico para hacer diferentes preguntas, como problemas de pago, necesidad de revisión, problemas de desbloqueo con herramientas o canales, o bien otros obstáculos?
  • ¿Hay un proceso específico que el escritor debe seguir para enviar su trabajo o obtener comentarios o revisiones?

Herramientas

  • ¿Qué herramientas (o versiones de herramientas) debe usar el escritor técnico para crear su trabajo?
  • ¿Quién es responsable de ayudar al redactor técnico a configurarse, obtener acceso o permisos?

Cómo 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 fechas límite seguidas o entregar trabajos de una calidad inaceptable. Cuando apliques el proceso, considera indicar los próximos pasos de forma explícita ("Esperamos que se envíe una solicitud de extracción para el primer borrador el próximo viernes" en lugar de "Envía tu trabajo lo antes posible").
  • Si un escritor técnico necesita abandonar el proyecto, ¿cómo debería comunicarlo? Si es posible, ¿debe dar aviso, crear un documento de entrega o tener una llamada de entrega?
  • No olvides considerar las obligaciones del proyecto para el escritor técnico. Por ejemplo, si los mentores de tu proyecto abandonan el proyecto y no se pueden reemplazar, o si no se pueden completar las revisiones prometidas, considera pagar una parte de los fondos restantes al escritor técnico, incluso si no se puede completar el proyecto, para compensarlo por su tiempo.
  • Indica de forma explícita que el escritor técnico está sujeto al Código de Conducta del proyecto y agrega un vínculo al proceso de aplicación del Código de Conducta. Te recomendamos que explicites que los incumplimientos del CoC provocarán la rescisión del proyecto y la pérdida del pago por cualquier trabajo pendiente.