¿Cuáles son algunas de las mejores prácticas para administrar un equipo de redactores técnicos?

Respuestas cortas:

  • Contrata escritores en los que puedas confiar y luego confía en ellos.
  • Mucha revisión por pares. Los escritores deben revisar el trabajo del otro.
  • Haga que trabajen juntos en una Guía de estilo, o si ese no es un buen uso de los recursos, decida qué elementos del estilo de una casa son importantes para usted y luego haga que se cumplan.
  • Configure una herramienta como Confluence que tenga control de versiones o la propiedad de los módulos de documentación para garantizar que las personas no ‘colisionen’ (control de fuente). Si está loco, puede guardar archivos fuente de documentos en una herramienta como P4 o ClearCase, pero eso suele ser demasiado engorroso para que valga la pena.
  • La redundancia es buena, en caso de que uno de sus escritores se vaya, pero también trate de averiguar qué partes del trabajo disfruta, es bueno o quiere aprender cada persona. Asignar trabajo de acuerdo con ese conocimiento.

Un colega mío está organizando un seminario web gratuito para gerentes sobre la motivación y el empoderamiento de los equipos de contenido global http://bit.ly/1WXn26B . Espero que esto ayude a alguien. Hay una grabación si no puede asistir, pero tiene que registrarse. ¡Espero que esto ayude!

  • Use plantillas y estilos para asegurarse de que todos tengan el mismo formato
  • Revisión por pares: evita que la documentación influya demasiado en el estilo personal del escritor
  • Encontré que Git funcionaba bien para el control de versiones. Utiliza la GUI básica de Git para ver los cambios específicos en un archivo .docx, no lo muestra perfectamente pero es lo suficientemente bueno como para tener una idea de los cambios.

Personalmente, creo que puedo tratar de alejarme de esas formas tradicionales de documentación y buscar una wiki en su lugar, tal vez con guías de inicio rápido estándar para cubrir los conceptos básicos. De esa manera, todos los equipos, no solo el equipo de documentación, pueden editar la documentación simultáneamente y sirve mejor al usuario, ya que en la actualidad si su manual tiene más de 5 páginas, nadie lo leerá de principio a fin.