Estoy confundido acerca de cómo aplicar el concepto de DITA para una receta. ¿Existe la posibilidad de mapear la tarea, el concepto, la referencia al nombre de la receta (tema), la información de introducción, los ingredientes y el proceso de elaboración (pasos / concepto)?

Las recetas pueden ser simples, por lo que no son lo suficientemente ricas para realmente necesitar todos los tipos de información disponibles.

Una receta es un procedimiento con nombre que requiere información de requisitos previos (ingredientes, herramientas, horno de precalentamiento, etc.); una serie de pasos (como “golpear dos huevos” o “combinar 1 taza de leche con 1 onza de chocolate derretido en un recipiente para mezclar”); y un punto final (como “dejar enfriar y servir”). Por sí misma, una receta se escribe mejor como una tarea, y hay etiquetas de tareas que le permiten escribir el nombre del plato, los requisitos previos, los pasos, los resultados y los ejemplos (para una foto del plato terminado). No necesita dividir una receta individual en múltiples temas; de hecho, sugiero que intentar convertir el nombre, la lista de ingredientes y los pasos en temas separados es un malentendido y un error.

Si desea combinar recetas en una unidad más grande (es decir, un libro de cocina), entonces querría otro tipo de temas. Si mira un libro de cocina, puede encontrar que hay secciones o capítulos sobre los tipos de platos (platos de carne, platos de verduras, platos franceses, platos chinos, postres, etc.). La información general sobre estos diferentes tipos de platos se escribiría mejor como temas conceptuales. En este caso, creo que querrías y necesitaría temas conceptuales.

Finalmente, los libros de cocina también pueden contener información que no es conceptual ni procesal. Por ejemplo, un libro de cocina puede incluir una tabla de recuentos de calorías para diferentes tipos de carne, o ajustes en el tiempo de cocción a diferentes altitudes, o cómo congelar diferentes tipos de fruta y cuánto tiempo se mantienen. Este tipo de información (que tienden a aparecer como tablas independientes) se tipea mejor como temas de referencia.

Por lo tanto, creo que una receta es claramente una tarea de procedimiento, y no debe subdividirse en temas; pero un libro de cocina tiene suficiente variedad de información para merecer la adición de conceptos y temas de referencia.

¡Bien! DITA es más adecuado para entornos que tienen equipos de escritura y edición completamente desarrollados. Según entiendo, su aplicación del concepto DITA para una receta se trata de estructurar su información en función de los tipos de información prescritos por DITA .

Lo que sugieres en la pregunta parece correcto. Así es como clasificaría una información de receta en los tipos de información:

  1. Introducción a la receta (concepto)
  2. Herramientas e ingredientes requeridos (Concepto / referencia)
  3. El proceso de elaboración (procedural)
  4. El resultado (referencia)
  5. Recetas similares (Referencia)

Comprenda que conocer el tipo de información para sus temas no es la tarea más importante, pero saber cómo se debe personalizar el tipo de información es la verdadera solución.

Suponiendo que va a utilizar estas plantillas para documentar varias recetas, aquí es cómo podría templatar los tipos de información:

  • Concepto

    Solo deben permitirse las etiquetas

    y el autor debe incluir una subsección que tenga traducciones para palabras clave (puede ser una subsección de palabras clave o puede tener notas al pie como una subsección en la que se definen algunos términos que se usan en la sección del concepto

    Estas restricciones son para asegurar que cada autor que escribe una receta siga consistentemente las pautas conceptuales del tema.

  • Procesal

    Solo se permite la lista y . Una vez más, estas restricciones permitirán la coherencia de todas las recetas que se crearán.

    Si desea que sea obligatorio etiquetar los pasos junto con las imágenes respectivas. Haga que sea una etiqueta obligatoria para cada paso de este tema.

  • Referencia

    Solo se permiten imágenes con título. Y, hay una subsección de solución de problemas que debe llenarse, ya que creo, cada plato decentemente preparado puede corregirse a la perfección después de que haya sido preparado.

Eso es.

PD : creo que para documentar las recetas realmente no necesitas implementar los conceptos de DITA. Puede preparar una plantilla (que tenga todos los tipos de temas DITA) que cada autor llena. Si personaliza la plantilla según sus necesidades, entendiendo cómo sus clientes querrían su contenido, deberá documentar mejor las recetas porque (tal vez ya lo sepa) ningún cliente valora la categorización de información basada en DITA, aprecian la estructura e información fácil de comprender e implementar. Buena suerte.