Giter Club home page Giter Club logo

writing-toolkit's Introduction

Guida al linguaggio della Pubblica Amministrazione

Vai al documento su Docs Italia.

Dipendenze

Il repository è strutturato per essere compatibile con Docs Italia. La piattaforma accetta documenti in formato RST o MD. Per informazioni sulla struttura di questo repository visita il repository dedicato.

Anteprima

Per lavorare utilizzando un'anteprima del documento è sufficiente lanciare Docker.

docker-compose up

la preview sarà visibile all'indirizzo http://localhost:8000/

Come contribuire

Ogni contributo è benvenuto! È possibile aprire delle issue per segnalare errori, problemi o per la richiesta di nuove funzionalità. Inoltre, è possibile aprire delle Pull Request per proporre direttamente delle modifiche.

Licenza

Questo documento è rilasciato con una licenza CC BY 4.0.

writing-toolkit's People

Contributors

alterat avatar andreatironi1 avatar bfabio avatar cdeiacobis avatar francescomda avatar francescozaia avatar giacomomason avatar gianvitofanelli avatar pdavide avatar steliopagn avatar valefa avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

writing-toolkit's Issues

Ore e minuti

Nella pagina
https://docs.italia.it/italia/designers-italia/writing-toolkit/it/bozza/suggerimenti-di-scrittura/numeri-e-date.html
Consiglio di aggiungere Ore e minuti.
Ore e minuti non si scrivono separandoli da "." o "," ma da ":"
es: 18:06

(Bella la bozza del glossario, finalmente con esempi pratici.
idea fuori dalla Issue:
Magari prima che l'AI scriva gli articoli da soli, potreste pensare a un semplice funzione (JS o qualcosa del genere) che es: analizza URL della pagina e evidenzia probabili termini "brurocratesi".
Ovviamente è la conoscenza e la formazione di chi scrive che la fa da padrone).

Documentazione digitale

È possibile definire con il termine "documentazione digitale" la documentazione distribuita con "readthedocs"? E quest'ultima come si può differenziare da tutta la documentazione già ampiamente diffusa online, ma non fruibile allo stesso modo? Penso ad esempio a principi come il "mobile first " (altro termine da inserire nel glossario a mio parere). Grazie

Riferimenti normativi

Nel paragrafo 2.2.9 il riferimento normativo (in questo caso alla legge sulla privacy) contravviene a quanto raccomandato nel paragrafo 1.4 secondo cui in "d.lgs" le iniziali sono minuscule.

termini ricorrenti

sostituirei il titolo della sezione da "termini ricorrenti" a "elementi ricorrenti", in quanto comunque questa sezione racchiude i riferimenti normativi che ad esempio io non classificherei come "termine" ricorrente all'interno di un documento della PA.

Elenchi numerati

Al paragrafo 2.2.1 nella parte relativa agli elenchi numerati, il punto 1. secondo me dovrebbe prevedere il punto fermo "alla fine di ogni frase" (non all'inizio, come indicato).

Uso delle note

Sarebbe opportuno indicare che l'uso delle note va ristretto soltanto a pochi casi (da definire) e mai andrebbero usate per mettere dei link, i quali vanno integrati nel corpo del testo.

Build instruction missing

There is no quick info on how to build the documentation locally in the README.

I tried going with

$ pip install git+https://github.com/italia/docs-italia-theme.git

and

$ sphinx-build . _build

but it failed:

Running Sphinx v2.2.2
loading translations [it]... fatto

Theme error:
no theme named 'docs-italia-theme' found (missing theme.conf?)

Open Data

potrebbe essere utile introdurre un chiarimento riguardo l'uso di queste parole:
Open Data
opendata
OpenData
dati aperti

Iniziali Corte dei conti

Alla voce Corte del glossario si legge che le iniziali della Corte dei Conti sono entrambe maiuscole, rappresentando un'eccezione alla regola. Tuttavia, la maggior parte delle occorrenze sul sito istituzionale, il simbolo e il logo ufficiali usano la notazione Corte dei conti, con la seconda c in minuscolo. Questa è anche la dicitura impiegata nelle norme, tra cui l'art.100 della Costituzione. A cosa è dovuta l'eccezione?

admonition box

hanno un comportamento strano in modalità preview, si annidano (all'infinito ∞)
image

ICT in glossario

Ho notato che manca la parola ICT.
Può essere utile inserirla?
E in che modo? (usando l'acronimo dall'inglese o cercando un corrispettivo in italiano, soprattutto considerando che spesso viene usata in modo improprio)

Acronimi in maiuscolo

Buongiorno,
con che logica alcuni termini hanno gli acronimi in maiuscolo
( es: AGID https://github.com/italia/writing-toolkit/blob/master/le-parole-della-pubblica-amministrazione/a.rst )
mentre altri termini hanno gli acronimi in minuscolo (tranne l'iniziale)
( es: Cdp https://github.com/italia/writing-toolkit/blob/master/le-parole-della-pubblica-amministrazione/c.rst )
?

Penso che il maiuscolo di un acronimo aiuti, in un documento corposo, a identificare velocemente dove viene richiamato il termine.
Cercando ad esempio su modulistica ufficiale di Cassa Depositi e Prestiti (CDP), c'è scritto l'acronimo in maiuscolo.
Se non c'è descritta una logica razionale su questo punto nella bozza del glossario (che rimane una iniziativa pregevole), purtroppo inevitabilmente diminuirà il peso con cui si potrà esigere che le PA facciano fede a questa guida.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.