Instruction file imported from daniele-quero/cook (
.github/instructions/write.instructions.md). Copyright stays with the author.
Recipe Maintenance — Linee guida per il repository cook
Questo documento definisce le regole operative per la creazione, revisione e manutenzione delle ricette e delle guide tecniche nel repository. Le stesse regole (front-matter, template, suffissi, SEO editoriale, limiti di contenuto) valgono per entrambi i contenuti: l'unica differenza è la cartella di destinazione (webapp/recipes/ per le ricette, webapp/guides/ per le guide tecniche generali su uno strumento o una tecnica, non legate a un piatto specifico) e il fatto che una guida può non avere una tabella Ingredienti dosabile (in tal caso non si usa il tag <main>, ma main_ingredient nel front-matter resta comunque valorizzato con l'argomento/tecnica/strumento principale).
Scopo
Assicurare coerenza strutturale, sicurezza alimentare e facilità di pubblicazione per tutte le ricette.
Regole di base
- Lingua: italiano.
- Nome file: kebab-case (minuscolo, parole-separate-da-trattini). Evitare date, numeri seriali e suffissi ridondanti (vedi Suffissi Ridondanti da evitare).
- Front-matter YAML minimo obbligatorio:
title,description,thumbnail,main_ingredient,tags,prep_time,cook_time,total_time,difficulty. Aggiungere se manca. descriptione' una sintesi SEO unica in italiano di 120-160 caratteri circa: descrive fedelmente tecnica, ingrediente o risultato gia' presenti nel file, senza keyword stuffing. Per contenuti sanitari o dietetici deve usare tono informativo e non promettere effetti o benefici medici.thumbnaildeve essere un percorso locale root-relative dell'immagine gourmet piu' pertinente alla ricetta, nel formato/gourmet/nome-gourmet.jpg. Le immagini disponibili e servite dalla webapp sono inwebapp/public/gourmet/; non usare URL esterni.main_ingredientidentifica l'ingrediente dominante della ricetta. Inferirlo dal titolo, dalla sezione Ingredienti e dalla tecnica; quando il caso resta ambiguo, scegliere il componente che definisce il piatto e non un aroma o un condimento.- rimuovere dal front-matter i campi
date,authors,servings. - In ogni ricetta, subito dopo il titolo e prima della sezione
## 1. Preparazione, inserire un blocco<nota editoriale>di 2-4 frasi in italiano che risponda a: da che necessità nasce la ricetta, quale problema risolve e perché questa versione è utile o più interessante della variante standard. - Usare sempre il template canonico, usa read_file su:
../../.github/templates/recipe-canonical-template.md. - Non cambiare il contenuto sostanziale, incluse quantita', tempi, temperature, pH, conservazione, allergeni, controindicazioni e avvertenze.
- Quando il compito richiede esplicitamente SEO editoriale, e' consentito aggiungere o correggere soltanto
descriptione il grassetto Markdown secondo la regola successiva. - Applicare solo una ristrutturazione secondo il template. Se mancano sezioni, ometterle; non inventare dati di sicurezza.
- Titoli semplici e chiari, senza suffissi ridondanti (vedi Suffissi Ridondanti da evitare): riscrivi il titolo se non aderisce a questo standard. Sono ammesse indicazioni sul tipo di cottura se rilevanti (es. "Sous-vide", "Vasocottura", "Infusione a freddo").
- La ricetta riscritta DEVE sempre sostituire completamente la versione precedente. Non aggiungere commenti o note di revisione nel file finale.
- Rimuovere riferimenti a date nel corpo della ricetta.
Ingrediente principale e dosi proporzionali
- Nella tabella
Ingredienti, racchiudere l'ingrediente principale con il tag esatto<main>...</main>. Il testo nel tag deve corrispondere semanticamente amain_ingredient. - Per le tabelle verticali, il tag va nella cella della colonna Ingrediente; per tabelle con ingredienti in intestazione, va nell'intestazione del main ingredient. Non usare il tag in tabelle di temperature, sicurezza, conservazione, confronti o troubleshooting.
- Quando una sezione Ingredienti contiene più tabelle o profili, ogni tabella dosabile deve avere il proprio tag
<main>...</main>per lo stesso ingrediente principale. Ogni tabella è scalata in modo indipendente; non marcare una tabella tecnica che precede o segue la sezione Ingredienti. - Le proporzioni degli altri ingredienti sono calcolate dalla webapp come metadati invisibili rispetto alla quantità base del main ingredient. Non aggiungere rapporti tecnici visibili nel testo della ricetta soltanto per la UI.
- Sono scalabili solo quantità numeriche singole o intervalli con unità semplici:
g,kg,mg,ml,l,cl, pezzi, spicchi, foglie, rametti, cucchiaini e cucchiai.q.b., percentuali, rapporti conper, formule, spessori e testo libero restano invariati. - Se il main ingredient non compare in una tabella Ingredienti oppure non ha una quantità affidabile, aggiungere comunque
main_ingrediental frontmatter ma non inventare una riga o una dose per poterlo marcare.
SEO editoriale e grassetto
- Il grassetto migliora la leggibilita' ma non e' una tecnica per aumentare artificialmente il ranking.
- Aggiungere al massimo due enfasi
**...**per ricetta, una sola volta per frase, esclusivamente nella prosa ordinaria e solo se la frase esiste gia' ed e' naturalmente rilevante: titolo/ingrediente principale e, facoltativamente, tecnica distintiva. - Non aggiungere parole, non ripetere keyword e non trasformare il grassetto in elenco di termini di ricerca.
- Non usare mai grassetto in front-matter, titoli, intestazioni, tabelle, link, citazioni, blocchi codice, elenchi di istruzioni di sicurezza o nella sezione
Sicurezza Alimentare. - Non enfatizzare mai quantita', unita', tempi, temperature, pH, conservazione, allergeni, controindicazioni, avvertenze o affermazioni mediche. Per contenuti sanitari, non enfatizzare mai benefici o effetti terapeutici.
Suffissi Ridondanti da evitare
- "guida ..."
- qualunque rimando a risultati ed effetti finali
- qualunque dettagliato riferimento a modelli o marchi di apparecchiature
- qualunque dettagliato riferimento a elenchi di ingredienti (es. "Pesto di rucola con olio, aglio e pinoli" → "Pesto di rucola")
Esempi di contenuti da evitare e da rimuovere nei titoli:
- Metodo controllato
- Guida completa
- Ricetta passo passo
- Guida Completa per Fette da 0,6 cm
- Guida Scientifica e Pratica
- Guida Scientifica
- Russell Hobbs Satisfry 26520-56
- Weck
- Guida Scientifica e Operativa
- Guida agli Ingredienti Vegetali Secchi
Naming convention (esempi)
polpo-sous-vide.mdmaionese-frullatore.mdcold-brew-coffee.md(mantenere termini internazionali noti)
PR checklist minima (da includere nella descrizione PR)
- Il file utilizza il template canonico.
- Front-matter YAML è completo.
-
descriptione' una sintesi originale, fattuale e coerente con il contenuto. - Presente la sezione
Sicurezza Alimentare. - Tabelle Temperature/Tempo/Texture presenti e chiare.
- Se sono stati rinominati file, i link interni sono aggiornati.
- Revisione umana richiesta per modifiche di sicurezza.
Tag principali ammessi
- verdura
- frutta
- carne
- pesce
- uova
- latticini
- cereali
- legumi
- pollo
- salsa
- sous-vide
- vasocottura
- bevanda
- dolce
- pasta
- patate
- funghi
- microonde
- contorno
- secondo
- primo
- impasto
Limiti di contenuto
Limitare il contenuto (tutto ciò che NON è frontmatter YAML) ad un massimo di 18000 caratteri. Se il contenuto supera questo limite, riduci la lunghezza del testo senza rimuovere informazioni essenziali:
- elimina le newline dopo i titoli:
# Titolo contenuto - massimo una newline tra paragrafi
linea 1 linea 2 - rimuovi eventuali spazi bianchi in eccesso
- limitare
---a massimo 1 occorrenza consecutiva - limitare
---a massimo 4 occorrenza totali - rimuovere la dicitura
(OBBLIGATORIA)dai titoli di sezione come la Sicurezza Alimentare - se prossimi a 18000 caratteri, riformulare frasi lunghe in più frasi brevi, senza rimuovere informazioni essenziali.
Note finali
- la sezione Fattibilità è deprecata e da rimuovere ovunque.
- applica