Maybe Our Documentation "Best Practices" Aren''t Really Best Practices

Kayce Basques, un asombroso escritor de tecnología de nuestro equipo, escribió un artículo bastante sorprendente sobre sus experiencias en la medición de cómo funcionan las mejores prácticas de documentación existentes para explicar material técnico. Las mejores prácticas en este sentido pueden ser los estándares conocidos de la industria para la redacción técnica o la guía de estilo de redacción de sus propias empresas. ¡Echale un vistazo!

Recently I discovered that a supposed documentation “best practice” may not actually stand up to scrutiny when measured in the wild. I’m now on a mission to get a “was this page helpful?” feedback widget on every documentation page on the web. It’s not the end-all be-all solution, but it’s a start towards a more rigorous understanding of what actually makes our docs more helpful.

Read full post .

Aunque no soy un escritor de tecnología, mi función implica una gran cantidad de compromiso con nuestro equipo de redacción de tecnología, así como la publicación de muchas "mejores prácticas" para los desarrolladores. Me sorprendió la profundidad y la investigación que Kayce ha hecho sobre el arte de escribir documentos modernos a través de la lente del contenido de nuestros equipos. Te animo a que leas el artículo de Kayce en profundidad; aprendí mucho. ¡Gracias Kayce!

Paul Kinlan

Trying to make the web and developers better.

RSS Github Medium