LA RECETA
Una receta es un documento corto (2 o 3 páginas) cuyo fin es describir un procedimiento o técnica de forma directa y práctica, evitando ornamentos literarios. Es una versión aún más reducida de los llamados mini-howto's ya que ni siquiera se espera que una receta incluya una explicación técnica detallada de cada acción.
Utiliza segunda persona del singular (tú, usted) para referirse al lector, preferiblemente el IMPERATIVO, como por ejemplo "copia el fichero en tu home". De ese modo resulta más directo y claro. Evita las formas plurales, como "ahora copiamos el fichero en nuestro home", que pueden ser confusas o ambiguas en muchos casos (no hay "homes" colectivos).
Y aunque no tendría ni que pedirse, el único requisito imprescindible e inexcusable es el de respetar escrupulosamente la ortografía y la gramática. Tus lectores y sobre todo los editores te lo agradecerán infinitamente.
ESTRUCTURA DEL DOCUMENTO
Ya hemos hablado anteriormente en otros artículos de la conveniencia de fijar unas normas mínimas para el formato de las recetas. Las partes básicas de una receta son:
TÍTULO:
El título de la receta debe ser una frase que describa la utilidad de la misma de forma directa y concisa. Recordad que el título se rellena en un campo del formulario diferente del cuerpo, por lo que no tiene ningún tipo de estilo.
RESUMEN:
Es lo primero que debe aparecer en el cuerpo del documento. El resumen es un párrafo que explica con más detalle cuál es la utilidad de la receta. Se trata de que el lector no pierda tiempo leyéndola si no es eso lo que está buscando realmente.
CONTENIDO:
Dado el objetivo de una receta, resulta muy conveniente dividir el documento en tantos puntos (secciones y subsecciones) como pasos implique la realización del procedimiento que se describe.
Como el criterio principal de las recetas es siempre el tamaño, en lugar de incluir explicaciones detalladas, se aconseja añadir un apartado de referencias para que el lector pueda profundizar en el tema si lo desea.
PREGUNTA: La Receta Describe: