Cómo optimizar el SEO para la documentación técnica

📜 Contenido

• Introducción
• La importancia del SEO en la documentación técnica
• Mi experiencia con Dolby IO
• Sobre Dolby
• Dolby IO: la plataforma para desarrolladores
• Problemas con la visibilidad de la documentación
• Cómo funcionan los motores de búsqueda
• Trucos básicos para mejorar el SEO de la documentación
  • Mapas del sitio
  • Enlaces rotos y redireccionamientos
  • Texto alternativo en imágenes
  • Hosting de imágenes en el mismo dominio
  • Backlinks hacia la documentación
• Trucos más avanzados para mejorar el SEO de la documentación
  • Enlaces internos
  • Estructura de URL
• Evaluando los resultados y el impacto de las mejoras en el SEO
• Conclusiones y recomendaciones

🖊️ Introducción

¡Hola a todos! ¿Cómo están? Mi nombre es Braden Riggs y soy un Advocate de Desarrolladores en Dolby IO. En el día de hoy, quiero hablarles sobre la optimización para motores de búsqueda (SEO, por sus siglas en inglés) en la documentación técnica. Es importante comprender por qué debería importarnos y también quiero compartir algunos consejos y trucos para mejorar la visibilidad de nuestra documentación.

📝 La importancia del SEO en la documentación técnica

Antes de adentrarnos en los detalles, permítanme hablarles brevemente sobre cómo me involucré en este proyecto y por qué Dolby está interesada en la documentación técnica y el SEO. Conozcan un poco sobre mí: nací y crecí en Noosa, Australia, y luego me mudé a San Diego hace unos cinco años para estudiar ciencias de datos y aprendizaje automático en la universidad. Durante la pandemia, me trasladé a San Francisco para unirme al equipo de Dolby como Advocate de Desarrolladores. En Dolby, nos dedicamos a crear experiencias de audio y video premium, y nuestra plataforma para desarrolladores, Dolby IO, ofrece API y SDK para mejorar la calidad y la experiencia de contenido generado por los usuarios.

Sin embargo, a pesar de ser parte de Dolby, Dolby IO es una nueva dirección para la compañía, ya que es nuestra primera incursión en el mundo del software y la tecnología de autoservicio. Como parte del equipo de Dolby IO, mi objetivo es eliminar las barreras para la adopción de nuestras API y SDK, y una de las formas en que podemos lograrlo es asegurándonos de que nuestra documentación técnica sea fácilmente accesible y visible para los desarrolladores interesados.

📖 Mi experiencia con Dolby IO

Desde que me uní al equipo de Dolby IO como Advocate de Desarrolladores, he tenido la oportunidad de interactuar con diferentes comunidades y equipos, como la creación de contenido, el trabajo con los clientes y las presentaciones en eventos públicos. Sin embargo, uno de los aspectos más destacados de mi trabajo ha sido la forma en que los desarrolladores utilizan y encuentran nuestra documentación técnica.

Durante mis conversaciones con los posibles usuarios y desarrolladores de Dolby IO, he escuchado comentarios interesantes sobre cómo encuentran nuestra documentación. Algunos mencionan que han buscado "Plataforma para desarrolladores de Dolby IO" en la web, pero solo encuentran información sobre Dolby en general, y no la documentación específica de Dolby IO. Otros han expresado su frustración al no poder encontrar nuestro sitio web o nuestra documentación a través de los motores de búsqueda. Estas experiencias me han dejado en claro que necesitamos evaluar y comprender cómo las personas encuentran nuestros productos y cómo navegan por nuestra documentación.

🎯 Dolby: una introducción

Dolby es una reconocida compañía conocida por su innovación en el campo de las experiencias de audio y video. Seguramente ya hayan oído hablar de Dolby Cinema, Dolby Atmos o incluso puede que hayan visto Dolby Vision en algunos televisores. En realidad, Dolby ha estado presente en el mercado durante mucho tiempo, y es posible que incluso reconozcan sus tecnologías en lugares inesperados, como en el estéreo de mi coche.

Dolby se ha destacado en brindar experiencias premium en el ámbito del audio y recientemente ha demostrado mucho crecimiento en el campo visual. Al ser una empresa que se enfoca en cómo experimentamos y percibimos el sonido y la imagen, está naturalmente interesada en adaptarse a medida que nosotros cambiamos y evolucionamos en la forma en que consumimos contenido y medios de comunicación.

En este sentido, no es sorprendente que Dolby, como empresa enfocada en medios de alta calidad, esté incursionando en el mundo en línea. Así es como Dolby IO surgió. Dolby IO es la plataforma para desarrolladores de Dolby, que proporciona API y SDK para mejorar la calidad de audio en contenido generado por el usuario en diversas industrias, como la creación de podcasts, videoconferencias y soluciones de transmisión en vivo.

⚙ Dolby IO: la plataforma para desarrolladores

Dolby IO se ha convertido en un enfoque prioritario para Dolby. La plataforma ofrece herramientas y soluciones para una amplia gama de casos de uso, como la creación de aplicaciones de transmisión en vivo, la construcción de soluciones de videoconferencia y la integración de Dolby en eventos virtuales y conciertos. Estas herramientas aprovechan la tecnología de vanguardia de Dolby para crear experiencias de audio y video premium.

Mi papel como Advocate de Desarrolladores es facilitar la adopción de Dolby IO, eliminar las barreras para que los desarrolladores utilicen nuestras API y SDK, y garantizar que nuestra documentación técnica sea accesible y fácilmente comprensible para los desarrolladores.

🔍 Problemas con la visibilidad de la documentación

Durante mis interacciones con desarrolladores y usuarios potenciales de Dolby IO, me di cuenta de un problema recurrente: muchos desarrolladores tienen dificultades para encontrar nuestra documentación. Esta es una señal de alerta importante, ya que indica que no estamos brindando una experiencia de usuario adecuada y no estamos capturando el interés de este segmento de la audiencia.

Uno de los errores comunes en la escritura técnica es suponer que todos los usuarios navegan y encuentran contenido técnico de la misma manera. A menudo, esperamos que los usuarios visiten una página de producto, accedan a nuestra documentación y naveguen secuencialmente para encontrar lo que están buscando. Pero la realidad es que los motores de búsqueda pueden llevar a los desarrolladores a ubicaciones aleatorias a lo largo de su viaje hacia la documentación técnica. Por lo tanto, es fundamental evaluar y comprender cómo llegan los desarrolladores a nuestros productos, cómo navegan por nuestra documentación y dónde nos encuentran.

🎚 Trucos básicos para mejorar el SEO de la documentación

Para mejorar la visibilidad de nuestra documentación en los motores de búsqueda, no es necesario realizar cambios completos y reescribir todo el contenido. A menudo, es suficiente con implementar algunos sencillos trucos y mejoras. Permítanme compartirles algunos de ellos:

1️⃣ Mapas del sitio

Un mapa del sitio (sitemap) es un esquema que muestra la relación entre las páginas y los recursos de nuestro sitio web, proporcionando información valiosa sobre el contenido que ofrecemos. Esto permite a los motores de búsqueda entender mejor la estructura de nuestro sitio y la importancia de cada página. Además, un mapa del sitio puede incluir detalles como la última actualización de una página, versiones en diferentes idiomas y la cantidad de caracteres en la página. Incluir un mapa del sitio en nuestra documentación garantiza que los motores de búsqueda puedan indexar y mostrar nuestras páginas de manera adecuada.

2️⃣ Enlaces rotos y redireccionamientos

Los enlaces rotos son una mala experiencia tanto para los usuarios como para los motores de búsqueda. Cuando un enlace lleva a una página que no existe (error 404), esto indica a los motores de búsqueda que posiblemente esa página ya no está en uso o no aporta valor. Por otro lado, los redireccionamientos son útiles cuando hemos cambiado nombres de productos, modificado la estructura de nuestro sitio o cambiado de dominio. Es importante corregir los enlaces rotos y asegurarnos de que nuestras páginas se redirijan adecuadamente cuando sea necesario. Esto evita dañar nuestro SEO y mejora la experiencia del usuario.

3️⃣ Texto alternativo en imágenes

El texto alternativo (alt text) es una característica de accesibilidad que permite a los usuarios leer o escuchar una descripción de una imagen y su relación con la página. Proporcionar texto alternativo en las imágenes no solo mejora la accesibilidad de nuestro contenido, sino que también es valorado por los motores de búsqueda. De hecho, los motores de búsqueda penalizan las páginas que no incluyen texto alternativo en sus imágenes. Además de mejorar el SEO, esto también garantiza una experiencia más inclusiva para todos los usuarios.

4️⃣ Hosting de imágenes en el mismo dominio

Una estrategia interesante para mejorar el SEO de nuestra documentación es alojar las imágenes en el mismo dominio que estamos utilizando para mostrarlas. A veces, utilizamos servicios de almacenamiento externos para nuestras imágenes, pero esto puede afectar la relación entre las imágenes y nuestro sitio web. Al alojar las imágenes en el mismo dominio, establecemos una conexión más sólida entre el contenido multimedia y el sitio en sí, lo que ayuda a los motores de búsqueda a comprender mejor nuestra página y determinar su valor.

5️⃣ Backlinks hacia la documentación

Los backlinks son enlaces desde otros sitios web que dirigen a los usuarios a nuestro sitio. Los motores de búsqueda consideran estos backlinks como votos de calidad y autenticidad de nuestro contenido. Cuantos más backlinks tengamos, más relevante y confiable será nuestro sitio para los motores de búsqueda. Incentivar a nuestra comunidad de desarrolladores y usuarios a generar backlinks hacia nuestra documentación es una forma efectiva de mejorar el SEO y aumentar la visibilidad de nuestro contenido.

Estos son solo algunos trucos básicos que pueden ayudarnos a mejorar el SEO de nuestra documentación. La implementación de estas mejoras puede variar según nuestras necesidades y recursos, pero incluso realizar pequeños cambios puede tener un impacto significativo en la visibilidad de nuestro sitio.

(Siguiente parte continuará en la próxima respuesta)