Cualquiera que haya creado un producto quiere comentarios de los usuarios: lo necesitamos más que nadie en el espacio de código abierto y lo exigimos más que nadie. Sin embargo, esta retroalimentación puede ser difícil de dar, difícil de recibir y difícil de actuar.
Mi producto es la documentación de software de código abierto, y también lo es, pero, al menos en el caso de la documentación, creo que hay una manera de hacer que la retroalimentación sea más fácil y efectiva, todo gracias a la teoría lingüística.
La razón es que los documentos son productos que se basan en el lenguaje natural.Si bien no todos somos expertos en documentación y sería un error pensar que lo somos, Sí Todos los expertos en lenguaje natural, si pensamos que no lo somos, estamos equivocados.Y -como digo más abajo- esto hace que todos la diferencia.
contenido:
- Cómo utilizar la teoría lingüística para recopilar mejores comentarios sobre la documentación
Los humanos pueden ser racionales
Una epopeya sobre la humanidad, la lógica, el lenguaje y la razón.
Los humanos somos lógicos. Con (1) y (2), ninguno de nosotros llegaría a la conclusión de (3):
- Todos los hombres son mortales.
- Sócrates es un hombre.
- Entonces Sócrates es mortal.
Sin embargo, estamos Varios razonable. Todos los que escuchen (1) y (2) a continuación concluirán (3), pero algunos pueden objetar esta premisa:
- Si el cielo es azul, los cerdos volarán.
- El cielo es azul.
- Por lo tanto, los cerdos pueden volar.
Pero tenemos lenguaje.como steven pinker elocuentemente:
“Cuando lees estas palabras, estás participando de una de las maravillas del mundo natural, porque tú y yo pertenecemos a una especie con habilidades extraordinarias: podemos moldear eventos en el cerebro de los demás con gran precisión. [. . . ] Podemos generar de forma fiable combinaciones precisas de nuevas ideas en la mente de los demás simplemente haciendo sonidos con la boca. «
(Rosado, instinto del lenguaje1994)
De hecho, nosotros todos Hay lenguaje.como René Descartes Sencillo (pero inequívoco) decir:
«Es un hecho muy notable que ningún ser humano es tan depravado y estúpido, ni siquiera los idiotas, que no pueden combinar diferentes palabras para formar el enunciado que expresan sus pensamientos; y por otro lado, ningún otro animal puede hacer esto A poco, no importa cuán perfecto y afortunado sea».
(Descartes, La Metodología de la Primera Filosofía y la Meditación1637)
mientras que el lenguaje humano es UnaLógico yoLógico excelentelógico.
- el lenguaje humano parece Unalógico, si no yológico. De hecho, decimos una cosa todos los días y la gente parece escuchar otra:
- Yo digo: Joe escribió un poema o Joe escribió una novelaEscuchó que Joe escribió uno u otro, no estoy seguro de cuál, pero ciertamente no haría ambos. Mientras tanto, te estarás preguntando por qué estoy repitiendo «Escrito por Joe»…
- Yo digo: Joe no hizo más de 3 llamadasEscuchaste que hizo exactamente 3, podría haberlo hecho mejor.
- Yo digo: Joe comió hasta 3 heladosEscuchó que ella comió un poco, no estoy seguro de cuánto, pero sea cual sea la cantidad, en realidad no fue tanto.
- Yo digo: Joe todavía está durmiendoOíste que ella dormía demasiado.
- …
- …
- …
- Sin embargo, nadie se quejó. Porque resultó ser exactamente lo que queríamos. P.ej:
- (Fondo: una habitación con ventanas pero sin aire acondicionado). Dije: ¡Es tan aburrido aquí! Vas y abres la ventana.
- Entonces, obviamente, hay un enfoque bastante serio para esta locura.
El lenguaje humano también es racional.Citando trabajo seminal pablo gricelas principales razones por las que solemos tratar de entendernos son:
«Nuestros intercambios conversacionales no suelen consistir en una serie de retóricas inconexas, y si lo hacen, no es razonable. Se caracterizan, al menos en cierta medida, como un esfuerzo cooperativo; en cierta medida por parte de cada participante. Ambos reconocen que han un propósito común o un conjunto de propósitos, o al menos una dirección mutuamente aceptable”.
(Gracia, Lógica y Diálogo, 1975)
Eso es, como continúa argumentando, porque el principio cooperativo universal de confianza tácita se basa en los siguientes cuatro estándares conversacionales:
- calidad (o verdad),
- relación (o conexión, correlación),
- cantidad (o cantidad óptima de información), y
- manera (o clara, no oscura, concisa, ordenada).
(Por supuesto, hemos estado ignorando estos estándares, pero así es como creas sarcasmo, sarcasmo o humor).
Creo que podemos usarlo para crear un terreno común entre nosotros y nuestros usuarios, lo que conduce a una mejor retroalimentación de la documentación.
Cómo utilizar la teoría lingüística para recopilar mejores comentarios sobre la documentación
Sugerencias sobre cómo mejorar el botón de comentarios de nuestro sitio web.
Una forma en que recopilamos comentarios de los usuarios sobre la documentación. macropolio Actualmente a través de una combinación de botones de comentarios del sitio y foros de discusión de Discourse.
El botón de comentarios del sitio está diseñado de la siguiente manera: cuando hace clic en él, se le invita a seleccionar la parte de la pantalla en la que desea proporcionar comentarios; luego verá una pantalla emergente con la pregunta «¿Encontró lo que buscaba?» buscando?». y una fila de 5 caritas sonrientes (odio, disgusto, neutral, me gusta, me gusta); finalmente, cuando selecciona una, la ventana emergente se expande para incluir un cuadro «Cualquier comentario» donde puede dejar un comentario y un «Correo electrónico (opcional )» caja. Los debates de Discourse son un mecanismo de retroalimentación avanzado en el que los usuarios no solo pueden comentar documentos, sino que, si los permisos de su foro son lo suficientemente altos, también pueden actualizar cualquier documento directamente.
La intención general es tener un enfoque doble, con botones para comentarios rápidos, casuales y unidireccionales y foros para una comunicación bidireccional más seria y participativa.
Sin embargo, mientras que el foro de Discourse se usa para comentarios sobre documentos como cualquier otro foro (e incluso mejor, ya que los usuarios con privilegios elevados también pueden intervenir directamente en el documento), el botón de comentarios del sitio no lo hace: las personas rara vez hacen clic en él y, cuando lo hacen. hecho, es difícil actuar sobre los comentarios o más apropiados para un foro.
Entonces, ¿por qué falla el botón de comentarios y cómo podemos mejorarlo?
Uno de los puntos de falla es el buzón de correo electrónico. Está marcado como opcional, por lo que rara vez se usa. Incluso si la gente lo usa y les respondo (incluso si nadie más puede beneficiarse de él), nunca obtengo una respuesta. En general, no funciona. No obstante, esto está en línea con la idea de que este botón es para comunicación unidireccional, por lo que podemos dejarlo de lado. (Sin embargo, no sirve adecuadamente para un enfoque doble, por lo que deberíamos considerar agregar una nota para redirigir a los usuarios que buscan una comunicación bidireccional más profunda a Discourse).
Sin embargo, la razón principal del fracaso fue la escala de cara sonriente de cinco puntos. Por un lado, conduce a respuestas basadas en la emoción más que en la racionalidad. El mayor problema, sin embargo, es que no son tan útiles y procesables como sea posible, lo que a su vez significa menos posibilidades de que la documentación mejore y los usuarios estén más contentos.
Propongo que cambiemos la escala de caritas sonrientes de cinco puntos a un conjunto de cuatro opciones precompletadas basadas en cuatro criterios conversacionales:
- (Calidad:) No es cierto.
- (Relación:) Esto es irrelevante aquí.
- (Cantidad:) Demasiada/muy poca información aquí.
- (Manera:) Podría decirse que esto es mejor.
Por ejemplo, suponga que un instructivo dice que puede lograr un objetivo determinado mediante el uso de un comando determinado. Los usuarios que prueben este comando y descubran que no funciona (por ejemplo, puede estar en desuso y la documentación no se ha actualizado) pueden usar el botón de comentarios para seleccionar el comando, luego elegir «Esto no es cierto», quizás aclarando «Lo probé en mi Ubuntu 20.04 y obtuve este error: …».
O digamos que tiene un instructivo donde las instrucciones a menudo se ven interrumpidas por definiciones. Los usuarios (especialmente aquellos familiarizados con nuestro objetivo de convertir documentos canónicos de acuerdo con Diátaxis) pueden comentar «esto es irrelevante aquí», quizás agregando «tal vez sería mejor mover esto a otro documento:…».
O, cuando el documento utiliza una estructura intratable y omite información clave, el usuario puede elegir tanto «esto podría decirse mejor» como «aquí hay muy poca información», tal vez aclarando «Todavía no sé» quién debería hacerlo de esta manera. «.
No puedo garantizar que este cambio cause más retroalimentación. Pero creo que conducirá a una retroalimentación más fácil de dar, más fácil de recibir y más fácil de actuar. Documentación que satisfaga mejor las necesidades de los usuarios y una relación más profunda y positiva entre los autores como expertos en documentación y los usuarios como co-expertos en lenguaje natural.
