1. Buone pratiche per il nome dell’e-service¶
NB: Il numero limite di caratteri consentiti per il nome è di 60
1.1. Struttura del nome¶
Si propone una struttura fissa del nome, per facilitarne la lettura e comprensione.
fortemente consigliati |
quando applicabili |
||
AZIONE |
OGGETTO |
PROGETTO/BASE DATO |
(CODICE) |
AZIONE/I che l’e-service abilita al fruitore: descrive cosa fa, a cosa serve l’e-service.
Es. ricerca, verifica. ➔Vedi Glossario delle azioni consigliate per la nomenclatura degli e-service
OGGETTO, ossia il dato in oggetto
Es. Codice Fiscale, ISEE
PROGETTO/BASE DATO separato dall’oggetto con un trattino.
Es. ANPR oppure WaaS
CODICE identificativo, inserito come ultimo elemento, tra parentesi.
Es. (C001)
E-service completi, che compiono numerose azioni, possono essere nominati con il semplice oggetto.
Es. “amministrazione trasparente”, “eventi”.
Suggeriamo di inserire codici solo quando significativi e riconoscibili per i fruitori, evitandoli ove non strettamente necessari. Il codice deve far riferimento a una norma o documentazione consultabile.
1.2. Altre buone pratiche: cosa fare e cosa non fare¶
Inserire spazi tra una parola e l’altra, senza utilizzare trattini: il catalogo è visitato da persone umane
utilizzare le maiuscole solo dove necessario
quando non strettamente necessari evitare abbreviazioni, acronimi, inglesismi e termini tecnici o utilizzati dall’ente erogatore ma difficilmente comprensibili in generale: gli e-service dovrebbero essere di facile lettura
non inserire termini quali “API”, “servizio”, “e-service”, “interoperabilità”: risultano ridondanti e sottraggono spazio al contenuto
non riportare il nome del fornitore o dell’ente erogatore, o codici identificativi dell’ente. Il nome dell’erogatore è già presente nella scheda dell’e-service
non riportare il nome del fruitore o gli attributi necessari alla fruizione: le informazioni sono contenute nella scheda dell’e-service e potrebbero essere
non utilizzare termini quali “new”, “nuovo”, “clone” o riferimenti alla versione: le informazioni sulla versione sono già contenute all’interno della scheda e-service
non devono essere presenti termini quali “SOAP”, “REST” in quanto l’architettura con cui è costruita l’API si trova già nella scheda di dettaglio dell’e-service
1.3. Glossario delle azioni consigliate per la nomenclatura degli e-service¶
Azione |
Significato dell’azione |
Esempi di e-service |
|---|---|---|
RICERCA/CONSULTAZIONE |
La ricerca (o consultazione) è:
|
|
VERIFICA |
Gli e-service di verifica consentono di verificare l’aderenza di informazioni di cui si è in possesso con la realtà dell’oggetto di interesse a cui si ritiene appartengano. Questi e-service possono, ad esempio, supportare la veridicità di dati autodichiarati. |
|
INVIO |
Azione tipica degli e-service a erogazione inversa, ovvero che ricevono dati dal fruitore. |
|
Altre azioni specifiche: ISCRIZIONE, RETTIFICA, CAMBIO, … |
Quando l’e-service è utilizzato per un’azione specifica, come una rettifica o un’iscrizione, è buona pratica specificarla nel nome |
|
1.4. Glossario delle azioni da evitare per la nomenclatura degli e-service¶
AZIONE |
COMMENTO |
|---|---|
FORNITURA |
Spesso utilizzato impropriamente al posto di consultazione. |
INTERROGAZIONE |
Utilizzato come sinonimo talvolta di consultazione, talvolta di ricerca. |
VALIDAZIONE |
Sinonimo di verifica. |
RECUPERO |
Sinonimo di consultazione. |
ACQUISIZIONE |
Sinonimo di consultazione o ricerca. |