¶ Cómo escribir una guía "cómo hacer"
El siguiente texto se ha extraído de https://diataxis.fr/how-to-guides/#writing-a-good-how-to-guide
Traducción realizada con la versión gratuita del traductor www.DeepL.com/Translator
¶ Describir una secuencia de acciones
Al igual que un tutorial, una guía de instrucciones contiene una secuencia de acciones, que tienen un orden. A diferencia de un tutorial, no tienes que empezar por el principio de toda la historia y llevar a tu lector hasta el final. Lo más probable es que su usuario también se encuentre en medio de algo, por lo que sólo tiene que proporcionarle un punto de partida al que sepa llegar y una conclusión que responda a una pregunta real.
Las guías de instrucciones deben ser fiables, pero no necesitan tener la repetibilidad de un tutorial.
¶ Resolver un problema
El problema o la tarea es la preocupación de una guía práctica: cíñete a ese objetivo práctico. Cualquier otra cosa que se añada -explicaciones innecesarias, por ejemplo- os distrae tanto a ti como al usuario y diluye el poder útil de la guía.
¶ No expliques los conceptos
Una explicación no muestra cómo hacer algo, por lo que una guía práctica no debería tratar de explicar las cosas. Las explicaciones simplemente se interponen en el camino de la acción. Si las explicaciones son importantes, enlaza con ellas.
¶ Ser flexible
Un tutorial tiene que ser didáctico por naturaleza, pero una guía práctica tiene que ser adaptable a los casos de uso del mundo real. Una guía práctica que no sirva para ningún otro propósito que no sea exactamente el que usted ha abordado no suele ser valiosa.
¶ Omitir lo innecesario
En las guías prácticas, la utilidad práctica es más útil que la exhaustividad. Mientras que un tutorial debe ser una guía completa de principio a fin, una guía práctica no lo es. Debe comenzar y terminar en algún lugar razonable y significativo, y exigir al lector que lo una a su propio trabajo.
¶ Preste atención a la denominación
Elija títulos que digan exactamente lo que muestra una guía práctica.
Cómo integrar la monitorización del rendimiento de las aplicaciones
bueno
Integrar la monitorización del rendimiento de las aplicaciones
malo: quizás el documento trata de cómo decidir si se debe, no de cómo hacerlo.
Monitorización del rendimiento de las aplicaciones
muy mal: tal vez se trata de cómo - pero tal vez se trata de si, o incluso sólo una explicación de lo que es
Tenga en cuenta que los motores de búsqueda aprecian los buenos títulos tanto como los humanos.