Docs for Developers: Guía de campo de un ingeniero para la redacción técnica

Opiniones de los lectores

El libro «Docs for Developers» ha recibido críticas dispares, alabado por sus claras directrices sobre documentación de software pero criticado por su falta de profundidad y ejemplos prácticos.

El libro ofrece directrices completas y directas para crear mejor documentación, es ameno y entretenido con situaciones realistas, incluye recursos útiles en el Apéndice B y es valioso tanto para desarrolladores como para redactores técnicos que quieran mejorar sus habilidades. Muchos usuarios lo consideraron esencial para los recién llegados a la escritura técnica y beneficioso para todos los tecnólogos en el desarrollo de software.

Los detractores sostienen que el libro carece de ejemplos prácticos y que sólo ofrece consejos generales y vagos sin suficiente detalle. Algunos críticos opinan que no merece la pena invertir en él, señalando que podría condensarse sin perder valor, y sugieren que puede no ser adecuado para escritores experimentados o para quienes ya estén versados en las prácticas de documentación.

(basado en 13 opiniones de lectores)

Título original:

Docs for Developers: An Engineer's Field Guide to Technical Writing

Contenido del libro:

Aprenda a integrar la programación con una buena documentación. Este libro le enseña el arte de la documentación para cada paso del ciclo de vida del desarrollo de software, desde la comprensión de las necesidades de los usuarios hasta la publicación, medición y mantenimiento de documentación útil para el desarrollador.

Los proyectos bien documentados ahorran tiempo tanto a los desarrolladores del proyecto como a los usuarios del software. Los proyectos sin la documentación adecuada sufren las consecuencias de la baja productividad de los desarrolladores, la escalabilidad del proyecto, la adopción por parte de los usuarios y la accesibilidad. En resumen: una mala documentación acaba con los proyectos.

Docs for Developers desmitifica el proceso de creación de una buena documentación para desarrolladores, siguiendo a un equipo de desarrolladores de software mientras trabajan para lanzar un nuevo producto. En cada paso del camino, aprenderá a través de ejemplos, plantillas y principios cómo crear, medir y mantener la documentación, herramientas que puede adaptar a las necesidades de su propia organización.

Lo que aprenderá

⬤  Crear registros de fricción y realizar investigaciones de usuarios para comprender sus frustraciones.

⬤ Investigar, redactar y escribir diferentes tipos de documentación, incluyendo READMEs, documentación API, tutoriales, contenido conceptual y notas de la versión.

⬤ Publicar y mantener la documentación junto con las versiones de código regulares.

⬤ Mida el éxito de los contenidos que crea mediante análisis y comentarios de los usuarios.

⬤ Organizar grandes conjuntos de documentación para ayudar a los usuarios a encontrar la información correcta en el momento adecuado.

A quién va dirigido este libro

Ideal para desarrolladores de software que necesitan crear documentación junto con el código, o para escritores técnicos, defensores de los desarrolladores, gestores de productos y otras funciones técnicas que crean y contribuyen a la documentación de sus productos y servicios.