Specifiche: formato, sintassi e semantica

Struttura canonica del file, significato delle sezioni e convenzioni di link per ottenere un documento leggibile e parseabile.

Struttura canonica e ordine delle sezioni

  • H1 con il nome del progetto/sito (obbligatorio)
  • Blockquote con una sintesi breve
  • Zero o più note interpretative (paragrafi/liste, ma non heading)
  • Zero o più sezioni H2, ciascuna con una “file list” di link

Righe di “file list”

  • Ogni voce è una riga lista Markdown con link nel formato [titolo](url)
  • Facoltativo: : seguito da una descrizione breve

Sezione “Optional”

  • Una sezione H2 chiamata “Optional” elenca URL utili ma non essenziali.
  • Strumento utile per generare contesti brevi: può essere esclusa automaticamente in alcuni flussi.

Link interni, esterni e mirror .md

  • Sono ammessi link sia interni sia esterni, se pertinenti e curati.
  • Convenzione consigliata: esporre versioni Markdown pulite delle pagine importanti sulla stessa URL con suffisso .md.
  • Regola speciale: per path senza filename, usare index.html.md.

Parseabilità e toolchain

  • Il formato è pensato per essere leggibile e al tempo stesso “machine-parseable”.
  • Esistono parser/CLI che convertono llms.txt in un “documento di contesto” (es. XML/JSON) per l’uso in prompt e pipeline.

Template pronto

# Nome Progetto / Nome Azienda

> Sintesi in 1–3 frasi: cosa fai, per chi, e qual è la “verità canonica” del sito.

Note interpretative (senza usare heading):
- Terminologia ufficiale
- Versioni/prodotti correnti vs legacy
- Regole importanti (compatibilità, limitazioni, geografie servite, SLA)

## Getting Started
- [Introduzione](https://example.com/docs/intro.md): Panoramica e concetti base
- [Installazione](https://example.com/docs/install.md): Setup passo-passo
- [FAQ](https://example.com/docs/faq.md): Risposte ai dubbi comuni

## Reference
- [API Reference](https://example.com/docs/api.md): Endpoint/metodi e parametri
- [Changelog](https://example.com/docs/changelog.md): Modifiche per versione

## Policy
- [Privacy](https://example.com/privacy.md): Trattamento dati
- [Termini](https://example.com/terms.md): Termini e condizioni
- [Sicurezza](https://example.com/security.md): Practice e disclosure

## Optional
- [Blog](https://example.com/blog/index.html.md): Approfondimenti non essenziali
- [Press kit](https://example.com/press.md)