Mejores prácticas para la creación de documentación técnica

Suele ocurrir que dejamos en un segundo plano la generación de la documentación técnica de nuestro software, ya que resulta una tarea tediosa y normalmente es la parte más descuidada de todo proyecto.

Este tipo de documentación debe ser elaborada para que el usuario pueda consultarla para conocer a fondo el producto, y no para ser leída como si otro tipo de texto se tratase, por lo que debe hacerse siguiendo unas pautas y teniendo en cuenta ciertas consideraciones.

En este taller vamos a ver a fondo cuales son las mejores prácticas a la hora de crear documentación técnica asociada a nuestro software, para que la experiencia de los usuarios a la hora de consultarla sea la mejor y ofrezca el contenido esperado.

Para ello te contamos qué es la documentación técnica, su función y cuáles son sus características principales, de forma que aprendas a crearla de la forma adecuada, para que el usuario final tenga claro todo lo que necesite consultar.

Otro aspecto importante es quién o quiénes deben ser las personas encargadas de crear este tipo de textos, porque tiene influencia en el resultado final, al igual que hay que saber para quién se crea esta documentación y la importancia de crear la misma.

También debes saber los diferentes tipos que existen de documentación y qué preguntas debes hacerte para poder elegir el más adecuado en cada caso que sea necesario desarrollar la misma.

Una vez que ya se ha creado el final, existen diferentes formas de alojar la misma, para ello te hablamos de la posibilidad de alojarla directamente en una web o un blog, o bien utilizando un repositorio como GitHub.

En ambos casos hay que saber cómo hacer que la experiencia de usuario sea la mejor a la hora de consultar nuestro documento técnico, por lo que te detallamos cuáles son los errores más comunes que hay que evitar en cada uno de esos casos.

Para completar el taller, queremos que conozcas las mejores recomendaciones a la hora de comenzar a hacer una escritura técnica, para ello primero detallamos lo que se conoce como las 7 C’s de la escritura técnica y después te contamos nuestras recomendaciones.

También te mostraremos una serie de ejemplos reales, de empresas muy conocidas, que aplican todas estas buenas prácticas a la hora de elaborar su documentación técnica.

Finalmente te hablamos de cómo comprobar que nuestra documentación está siendo útil al usuario de la misma. Para ello te contamos una serie de ideas para valorar los resultados, qué KPis se deben medir y qué herramientas se utilizan para ello, además cómo mejorar la usabilidad en caso de necesitarlo.

Entra ahora en este taller de Raquel Campuzano, Content Manager de Bitnami, y aprende las mejores prácticas crear una documentación lo más profesional posible y mejorar así la experiencia del usuario de la misma.