· PGI - Piccole Guide d'Informatica ·

Manifesto

Lo stile PGI: come si scrive una PGI

Introduzione

      Le PGI - Piccole Guide d'Informatica sono un progetto editoriale libero volto ad offrire al Lettore delle monografie (un manuale distinto per ogni argomento), ognuna da consultare quando se ne ha effettivo bisogno.
      Le PGI sono una soluzione pratica anche per l'Autore, che può scrivere di qualsiasi argomento e nelle dimensioni che preferisce (manuale lungo, manuale breve, appunti); inoltre, il ciclo di aggiornamento di ogni manuale è indipendente dagli altri.
      La stessa libertà di scelta vale per le traduzioni: il Traduttore sceglie liberamente i manuali o i documenti ufficiali da tradurre.
      In sostanza, le PGI sono manuali monografici distinti sui più disparati argomenti, che, avvalendosi anche di una formattazione predefinita, sono uniti da una certa uniformità stilistica.
      Questo documento stabilisce i criteri che definiscono lo stile PGI, ossia le norme che regolano la stesura delle PGI.

Che cosa sono le PGI

      Le PGI, utilizzando un'esposizione chiara e rapida, sono dei manuali d'introduzione e al tempo stesso delle guide rapide: infatti, prima consentono al lettore di apprendere l'uso di base del software descritto; poi rappresentano per il lettore diventato utente uno strumento per la consultazione rapida.
      Le PGI non sono manuali d'approfondimento: la descrizione approfondita del software nei suoi dettagli tecnici e teorici è affidata ai trattati per utenti avanzati.

Caratteristiche generali di un manuale PGI

      Un manuale PGI deve potersi considerare a tutti gli effetti un'opera letteraria, agile e snella, che descrive e spiega in modo chiaro e veloce.
      Un manuale PGI non deve essere una semplice e arida esposizione di concetti e nozioni, ma deve offrire tali concetti e nozioni secondo uno stile preciso, all'insegna della chiarezza e della brevità: da qui il suo valore letterario e didattico. In altre parole, la forma, se è un mezzo efficace di trasmissione del contenuto, è importante quanto e forse di più del contenuto stesso.
      Un manuale PGI dovrebbe poter essere aggiornato dall'autore originale, che nel manuale ha applicato il proprio personale metodo didattico; un autore diverso potrebbe incontrare delle difficoltà.

Caratteristiche di forma e di contenuto di un manuale PGI

      Un manuale PGI:

• deve essere redatto con LaTeX-PDFLaTeX (adatte le classi report e article, secondo i casi)¹;
• deve avvalersi dell'uso del colore;
• deve avere un titolo sintetico e diretto, non fuorviante;
• deve avere dimensioni il più possibile contenute;
• deve trattare l'argomento in modo che le varie parti si succedano in un ordine logico e conseguenziale;
• deve contenere periodi brevi, fare un uso limitato delle subordinate (per semplificare l'esposizione), usare in modo accorto la punteggiatura (per distinguere i concetti e per dare respiro al lettore);
• deve limitare, ove possibile, la trattazione discorsiva, che produce blocchi di testo troppo compatti;
• deve essere schematico (attraverso: l'adeguata scelta della classe del documento; la strutturazione logica in capitoli e/o in sezioni; il frequente ricorso agli elenchi puntati e numerati, alle tabelle e agli esempi, che movimentano il testo), per agevolare la memoria visiva;
• deve descrivere usando un tono impersonale e scientifico, evitando un tono colloquiale, confidenziale o scherzoso;
• deve avere un linguaggio sintetico, addirittura essenziale, per agevolare la lettura;
• deve avere un linguaggio il più possibile semplice e immediato, per consentire l'immediata comprensione e facilitare l'acquisizione mnemonica;
• deve evitare tutto ciò che è superfluo: i giri di parole, le ripetizioni, le tautologie, gli infiorettamenti linguistici, le battute umoristiche;
• deve evitare i termini stranieri non necessari (quando in italiano esiste il termine o l'espressione corrispondente)².
• deve essere assolutamente chiaro ed esplicito, per rendere scorrevole la lettura ed evitare al lettore l'interpretazione di brani ambigui o sibillini, che rallentano la lettura³;
• deve essere eminentemente pratico, senza superflue dissertazioni teoriche;
• non deve essere necessariamente completo (tanto meno deve essere un trattato enciclopedico su tutto lo scibile riguardante la materia trattata), ma deve essere sufficientemente completo da consentire al lettore di inquadrare l'argomento e mettere rapidamente in pratica i concetti appresi;
• deve essere specializzato, ossia deve trattare un argomento di dimensioni contenute, compatibilmente con la materia presa in esame: se necessario, bisogna frammentare un argomento troppo vasto, distribuendolo in più manuali⁴;
• non deve essere specialistico, cioè per addetti ai lavori.

¹Ciò consente l'allestimento di ipertesti PDF, ossia documenti formattati professionalmente (adatti alla stampa) ma `vivacizzati' dai collegamenti ipertestuali tipici dei documenti HTML (adatti alla consultazione su schermo).
<sup>2</sup>Per esempio, è assolutamente da usare l'espressione `programma di videoscrittura' (comprensibile per chiunque), in luogo del termine `editor'.
³La sibilla disse: Ibis redibis non morieris in bello, frase che poteva significare concetti diametralmente opposti (o vita o morte) soltanto in base alla posizione di una semplice virgola:

• Ibis redibis non, morieris in bello. = Andrai, non ritornerai, morirai in guerra.
• Ibis redibis, non morieris in bello. = Andrai, ritornerai, non morirai in guerra.

Manifesto

• Lo stile PGI: come si scrive una PGI

Privacy Policy  -  Personalizza tracciamento pubblicitario