Skip to content

Commit

Permalink
chore: cheatsheet delle linee guida
Browse files Browse the repository at this point in the history
  • Loading branch information
corradopetrelli committed Sep 26, 2023
1 parent 3973d78 commit 56e7a4f
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions GUIDELINES-CHEATSHEET.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# $\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 |

___
Puoi consultare le linee guida complete nel file [GUIDELINES.md](GUIDELINES.md).

0 comments on commit 56e7a4f

Please sign in to comment.