Guidelines - first draft

[serenasensini]

Buonasera bella gente!👋

Questa una prima bozza della stesura delle linee guida per ciò che concerne struttura e scrittura del libro.

Ho cercato di fornire diversi esempi, anche sfruttando l'ottimo lavoro pushato finora, per descrivere quanto mi è venuto in mente rispetto a come potremmo organizzare e comunicare attraverso questo progetto.

Ogni feedback è ben accetto!

[Cadienvan]

@serenasensini ottimo lavoro, mi piace molto e credo renda chiaro il punto.
Personalmente faccio fatica a scrivere testi prendendo in considerazione ognuna di queste cose, ma queste linee guida aiuteranno veramente molto.

L'unica cosa che ti chiedo è di lanciare un "npm run format" così da formattare il contenuto come da prettier attuale e poi fare un commit, altrimenti non passano i check!

[davideimola]

Una sola curiosità, ma per il resto tutto torna e veramente ottimo lavoro!

[corradopetrelli]

Ottimo lavoro! 💯

Propongo di creare un cheatsheet con queste linee guida in modo da poterlo consultare rapidamente durante la stesura dei capitoli. Cosa ne pensi @serenasensini ?

[serenasensini]

Ottimo lavoro! 💯

Propongo di creare un cheatsheet con queste linee guida in modo da poterlo consultare rapidamente durante la stesura dei capitoli. Cosa ne pensi @serenasensini ?

Abs. Me ne occupo nei prossimi giorni!

[corradopetrelli]

Ottimo lavoro! 💯
Propongo di creare un cheatsheet con queste linee guida in modo da poterlo consultare rapidamente durante la stesura dei capitoli. Cosa ne pensi @serenasensini ?

Abs. Me ne occupo nei prossimi giorni!

@serenasensini pensavo a qualcosa del genere, che ne dici?

$\textsf{Cheatsheet}$

$\textsf{Struttura dei capitoli}$

• Limitare il titolo a 5-6 parole massime;
• Scegliere un titolo auto-esplicativo, rappresentativo e rispettare le regole di scrittura;
• Utilizzare il "tu" anziché il "voi" per creare empatia con il lettore;
• Limitarsi a una gerarchia di sezioni fino al terzo livello;
• Utilizzare la sezione H1 solo per il titolo del capitolo.

$\textsf{Strategie di scrittura}$

• Dare visibilità a un genere neutrale o oscurare entrambi i generi per inclusività;
• Utilizzare formulazioni neutre o riformulare con "chi" per evitare riferimenti di genere;
• Utilizzare nomi collettivi o parole inglesi per evitare specificazioni di genere;
• Utilizzare forme impersonali o del passivo per evitare forme personali.

$\textsf{Esempi}$

Invece di...	Meglio usare...
L'uomo/la donna	Le persone
Lo sviluppatore/la sviluppatrice	Chi sviluppa, chi programma, la professione di developer
Il recruiter	Chi fa recruitement, la figura del/la recruiter
Il sistemista	Chi lavora come sistemista
L'ingegno dell'uomo	L'ingegno umano
Un developer	Un/a developer
Caro lettore	A te che leggi/Tu che leggi
Essere un dev	Indossare i panni da dev
Tutti gli informatici	Tutte le persone che lavorano nell'informatica/nel settore IT
Blacklist	Ignorelist
Whitelist	Allowlist

[serenasensini]

Ottimo lavoro! 💯
Propongo di creare un cheatsheet con queste linee guida in modo da poterlo consultare rapidamente durante la stesura dei capitoli. Cosa ne pensi @serenasensini ?

Abs. Me ne occupo nei prossimi giorni!

@serenasensini pensavo a qualcosa del genere, che ne dici?

* Limitare il titolo a 5-6 parole massime;

* Scegliere un titolo auto-esplicativo, rappresentativo e rispettare le regole di scrittura;

* Utilizzare il "tu" anziché il "voi" per creare empatia con il lettore;

* Limitarsi a una gerarchia di sezioni fino al terzo livello;

* Utilizzare la sezione H1 solo per il titolo del capitolo.

* Dare visibilità a un genere neutrale o oscurare entrambi i generi per inclusività;

* Utilizzare formulazioni neutre o riformulare con "chi" per evitare riferimenti di genere;

* Utilizzare nomi collettivi o parole inglesi per evitare specificazioni di genere;

* Utilizzare forme impersonali o del passivo per evitare forme personali.

Invece di... Meglio usare...
L'uomo/la donna Le persone
Lo sviluppatore/la sviluppatrice Chi sviluppa, chi programma, la professione di developer
Il recruiter Chi fa recruitement, la figura del/la recruiter
Il sistemista Chi lavora come sistemista
L'ingegno dell'uomo L'ingegno umano
Un developer Un/a developer
Caro lettore A te che leggi/Tu che leggi
Essere un dev Indossare i panni da dev
Tutti gli informatici Tutte le persone che lavorano nell'informatica/nel settore IT
Blacklist Ignorelist
Whitelist Allowlist

Non ho parole per la rapidità con cui l'hai tirato fuori. Mi sembra perfetto! 💯💯💯

[Cadienvan]

Come pensavate di rendere fruibile il cheatsheet? Un file MD GUIDELINES-CHEATSHEET.md? Magari aggiungerei giusto un rimando alle linee guida "complete" che vuole portare dentro Serena e direi che ci siamo!

[serenasensini]

Come pensavate di rendere fruibile il cheatsheet? Un file MD GUIDELINES-CHEATSHEET.md? Magari aggiungerei giusto un rimando alle linee guida "complete" che vuole portare dentro Serena e direi che ci siamo!

Esatto. Io farei un file separato con il cheatsheet, per poi aggiungere link alle linee guida complete. Se @corradopetrelli vuole aggiungere questo dettaglio al file cheatsheet e fare commit, direi che ci siamo!

[davideimola]

@serenasensini deve ancora apportare le modifiche alla gestione degli header, successivamente a questo direi che la linea guida sia valida!

[Cadienvan]

D'accordo con Serena ho portato io avanti la piccola modifica.
@davideimola @corradopetrelli se vi torna portiamo dentro!

[GuidoPenta]

Sensini è la mia eroina personale.

[GuidoPenta]

Per me assolutamente ok!