Por lo general, la voz del contenido de marketing no coincide con la voz del contenido técnico: el marketing está tratando de persuadirlo de que necesita algo; la escritura técnica generalmente le indica cómo usar algo. (Estoy hablando específicamente de software).
Tradicionalmente, he adoptado un enfoque tecnológico para las notas de lanzamiento: describo nuevas funciones y correcciones de errores de una manera directa, enfocada en el usuario. La gente de marmm a menudo describe las características con un vocabulario muy diferente. Para la mayoría del contenido, esta distinción es más clara: la documentación del software es techcomm; sitios web, blogs, comunicados de prensa son marcomm.
Se puede argumentar que las notas de la versión tienen un propósito de marketing además de un propósito técnico: llegar a los tomadores de decisiones comerciales además de a los usuarios de tipo técnico. ¿Cómo decides la voz apropiada para las notas de lanzamiento?
Creo que hay un caso muy sólido para argumentar que esta distinción entre la voz de marketing y la voz de comunicación tecnológica debe evitarse por completo. Existen dos motivos principales para esto:
En la antigüedad, cuando la comunicación tecnológica y el marketing se entregaban en papel, cada uno llegaba al cliente en un momento diferente y a través de un canal diferente. En general, terminaron con el uso de contenido de marketing antes de que tuvieran la oportunidad de ver contenido técnico. Pero la web ha cambiado todo eso. El contenido técnico y de marketing está disponible para el cliente en línea. Pero dado que el usuario encuentra este material principalmente mediante la búsqueda, no se sabe si su búsqueda lo llevará a un documento técnico o de marketing. Una marcada diferencia de estilo entre los dos es discordante para el cliente.
Existe una gran cantidad de evidencia que sugiere que el tono tradicional de marketing ra ra simplemente ya no funciona. La web permite a las personas obtener información de tantas fuentes que no tienen que someterse a propaganda descarada para obtener información sobre un producto. Los expertos en marketing respondieron moviéndose al marketing de contenido, que se enfoca en producir contenido que los lectores realmente quieren, como un medio para atraerlos al contenido de su empresa y construir la reputación de su empresa como expertos en el campo. Un buen marketing de contenidos no puede tener el viejo tono de marketing ra ra o simplemente no se leerá. Tech comm, por otro lado, ya no puede confiar en que el cliente ya haya comprado el producto. Muchos clientes van a tomar su decisión de compra en base a la calidad y disponibilidad de la documentación. No puede darse el lujo de descuidar este aspecto de cómo se utiliza la documentación. (Además, una vez que la empresa se dé cuenta de que los documentos técnicos están generando clientes potenciales, su participación en la corporación aumentará considerablemente).
Desafortunadamente, hay muchas personas de marketing impacientes que tienen dificultades para producir profundidad o sustancia, y muchos escritores tecnológicos gruñones de antaño que tienen dificultades para aceptar que tienen que escribir cosas que el público en general leerá al tomar una decisión de compra. Pero ambos grupos viven en el pasado. En la era del marketing de contenidos, todo el contenido es contenido de marketing, incluido (ya veces especialmente) el contenido de comunicaciones tecnológicas. Es todo una cosa. Todo debe tener el mismo tono.
Las notas de la versión deben describir lo que cambió según lo vieron los usuarios . Sin embargo, eso no significa necesariamente "todos los detalles técnicos sangrientos"; Al igual que con otros escritos técnicos, desea decirle al usuario lo que necesita saber (y tal vez un poco más), pero no desea abrumarlo con detalles innecesarios.
Si hay temas más grandes en un lanzamiento, también puede agregar una breve introducción sobre ellos. Las versiones principales a veces usan las notas de la versión para resaltar nuevas funciones clave, por ejemplo. Estos están menos orientados a la funcionalidad y pueden ser más de lo que está pensando como "marketing", pero los mejores, en mi experiencia, usan un estilo similar al que usaría en la descripción general de la documentación técnica. Las notas de la versión no son un vehículo de ventas.
Como ejemplo, consulte estas notas de versión recientes para Firefox . Son para una versión principal (58.0) y comienzan con un párrafo general. Luego ingresan a las notas individuales: nuevos comportamientos, errores corregidos, etc. Cada uno de ellos está orientado al usuario, como:
Nuevo: Mejoras en las capturas de pantalla de Firefox:
- Copie y pegue capturas de pantalla directamente en su portapapeles
- Las capturas de pantalla de Firefox ahora funcionan en el modo de navegación privadaCorregido: las fuentes instaladas en directorios no estándar ya no aparecerán en blanco para los usuarios de Linux
Desarrollador: implementó la API PerformanceNavigationTiming
Firefox también tiene notas de lanzamiento para desarrolladores , que dividen las notas por componente y brindan más detalles (y más enlaces). Los desarrolladores son una audiencia diferente a los usuarios finales; al igual que con su otra documentación, debe calibrar el contenido para la audiencia.
Si sus notas de lanzamiento son digitales (no en papel), también puede vincular a información relacionada. En el ejemplo de Firefox, el de la API PerformanceNavigationTiming es un enlace. Las notas de la versión de mi equipo a veces se vinculan a temas específicos en nuestra documentación. Las notas de la versión de Visual Studio Code demuestran este estilo. (Gracias a Bob por señalar algunos ejemplos en un comentario).
En un comentario sobre la pregunta, alguien planteó notas de la versión generadas a partir de comentarios de verificación de código. Tales notas de la versión son más un registro de cambios porque muestran todos los cambios "tal como ocurrieron". El tipo de notas de lanzamiento de las que estoy hablando, y que creo que está preguntando, son de un nivel más alto que eso y requieren un poco de destilación.
Escriba para la audiencia, utilizando la voz que mejor les ayude a comprender el significado y la importancia de las notas de publicación.
Si hay más de una audiencia (por ejemplo, usuarios finales y usuarios de API), escriba para ellos por separado.
Estoy de acuerdo con los puntos de Mark acerca de que la distinción se vuelve menos importante en el modelo actual de cómo su audiencia encuentra su contenido. Secespitus alude a la importancia de no molestar a tu audiencia técnica, lo que creo que también es bueno tener en cuenta.
Adoptaría el enfoque de Mark de no hacer una distinción en la voz, además de asegurarme de que los nuevos usuarios que tropiezan con los RN cuando realizan búsquedas encuentren suficiente información contextual sobre el producto. Para evitar molestar a sus usuarios existentes con información introductoria que puede percibirse como "sin sentido", considere dividirla en un tema de introducción. Los usuarios experimentados pueden hojearlo para ver qué cambió en la última versión, mientras que los usuarios nuevos (o potenciales) obtienen el contexto que necesitan para comprender mejor el resto del contenido.
En mi opinión, las notas de la versión deben escribirse en un estilo técnico, centrándose en las implicaciones técnicas de los cambios más recientes. Esto los convierte en una especie de mezcla entre los dos mundos: desea dirigirse a los tomadores de decisiones y al personal técnico y decirles qué ha cambiado en comparación con la versión anterior del software, enfatizando cuáles son los problemas que pueden surgir de estos cambios o qué los problemas son que estos cambios arreglan.
No desea vender las funciones más nuevas y el producto completo a los responsables de la toma de decisiones: ya compraron el producto y quieren saber si cambiar a la nueva versión les costará demasiado o si las correcciones compensarán los costos de actualización.
Tampoco desea vender el producto a los técnicos: ellos quieren saber qué cambiará en su trabajo diario al usar la nueva versión.
Pero desea que sea fácil y rápido de entender para todos los que estén familiarizados con la versión anterior del software.
Depende del tipo de software que esté entregando y de su audiencia.
Pasé más de 10 años en desarrollo integrado y escribí muchas notas de lanzamiento. En mi empresa, creamos las notas de la versión para una nueva versión de software directamente desde la herramienta de tickets. Así que el contenido se veía así:
nombre del producto
V1.2.3.4
V1.2.3.5
etcétera.
Mi público objetivo eran otros desarrolladores, que también conocían los detalles técnicos y no estaban impresionados por el marketing blabla.
Si su audiencia está más del lado del marketing, deje el 'diseño' de la nota de lanzamiento para el marketing y solo proporcione los datos. En su mayoría, son mejores para escribir documentos que no suenan técnicos. Teníamos un departamento de marketing separado. por esos documentos.
Las notas de la versión deben escribirse con la misma voz que la Guía del usuario, la Ayuda en línea y otra documentación, si tienen la misma audiencia, porque todo el contenido de la documentación (más que la "voz") se basa en las necesidades de la audiencia, el nivel de comprensión, y propósito
Cuando escribí las notas de la versión para el software Citrix Metaframe, las notas tenían contenido, profundidad de detalles, lenguaje y terminología apropiados para los administradores de red, porque eran la audiencia. Cuando escribí los archivos "Léame" para el software de gráficos de Mac, usé un lenguaje, detalles y un tono apropiados para usuarios finales y administradores (desde un taller de diseño gráfico de una sola persona hasta ingenieros de Boeing) porque eso es lo que iba a leer. a ellos.
"Técnico" no tiene que ser denso, plano y pasivo. La precisión y la claridad no desentonan con la sencillez y la comprensión; Ellos son iguales. Fácil de usar no tiene que ser campechano o informal.
Creo que la verdadera respuesta es, no tengas miedo de usar la palabra "tú" (habla con el lector), incluso en las notas técnicas de publicación. Sólo asegúrese de saber quién es "usted".
Mónica Celio