Docs Italia beta

Documenti pubblici, digitali.

2. Buone pratiche per la descrizione dell’e-service

Numero limite di caratteri consentiti per la descrizione: 250

  • La prima parte della descrizione dovrebbe rendere chiaro l’input e l’output (dato x, l’e-service restituisce y)

  • la descrizione dovrebbe essere esaustiva e chiara, ma coincisa e dovrebbe includere la formula estesa di eventuali acronimi utilizzati. Es. Archivio nazionale dei numeri civici delle strade urbane (ANNCSU)

  • ove possibile, fare riferimento alla norma

  • quando è presente un codice identificativo, è buona pratica mettere a disposizione dei fruitori la norma o documentazione di riferimento;

../_images/Fig_07_esempio_descrizione.webp
  • utilizzare le maiuscole solo dove necessario

../_images/Fig_09_esempio_descrizione.webp
  • non è necessario inserire informazioni tecniche già presenti nella scheda dell’e-service (es. tecnologia rest/soap, versione, attributi necessari)

../_images/Fig_08_esempio_descrizione.webp
  • non inserire contatti o informazioni sensibili: la descrizione sarà visibile pubblicamente.

../_images/Fig_10_esempio_descrizione.webp