Miglioramenti possibili a testi tecnici

@Marchetto, ho dato una raida lettura ad alcuni dei testi che hai mostrato nel tuo sito.

Il mio parere, che ovviamente è solo e soltanto il mio parere e non vuole essere assolutamente una prescrizione, ha i punti seguenti:

1) Estetica tipografica: così come io vedo i testi sullo schermo mi pare che titoli e titolino siano troppo neri rispetto al testo abbastanza chiaro; io proverei a vede come viene se per titoli e titolini si usasse il font sans serif in serie media; il fot sans serif è abbastanza diverso dal tondo con grazie per essere immediatamente notato per indicare qualcosa diverso dal resto del testo; inoltre la sua serie media è leggermente più scura, o appare leggermente più scura della serie media del tondo; per cui potresti ottenere un risultato esteticamante migliore con questa piccola modifica; “migliore” dipende dai gusti naturalmente. Io recentemente mi sono convertito alle prescrizioni di Bringhurst di non usare mai il nero, ma il maiuscoletto o altri font di contrasto nella forma ma non nella nerezza. Però ho il sospetto che i titoli o in titolini in maiuscoletto o in corsivo siano troppo leziosi per un rapporto tecnico del tipo di quelli che hai mostrato.

2) A stretto rigore tutte le equazioni che sicrivi sono equazioni fra grandezze; quindi hai due problemi quando scrivi i passaggi intermedi e i risultati finali, problemi che riguardano entrambi le unità di misura:

2.a) Controlla sempre che siano corrette e con gli esponenti giusti; senza capire tutto di quello che hai scritto, mi pare di avere notato almeno un risultato finale con le unità sbagliate:shock: Vedi Analysis of reservoir,§ 6.1

2.b) io stesso nella Guida GuIT ho scritto che le unità di misura possono essere omesse nei passaggi intermedi; ripensandoci e verificandolo in formule come le tue che non ho la più vaga idea di che cosa significhino) mi pare che la mia affermazione possa essere usata SOLO quando la formula è talmente complessa che metterle o non metterle vuol dire almeno una riga in più, oppure lo sforamento dei margini; se non fosse per questo problema pratico direi che sia meglio indicarle sempre; è più facile verificare la correttezza. D’altronde la formula di cui parlo nel punto 2.a ha effettivamente le unità di misura nell’unico passaggio intermedio (kN/m^2 nel numeratore e m al denominatore), mentre il risultato finale riporta solo m.

2.c) Attento a non perdere dei backslash per la strada: Nell’ultima formula della pagina 13 di Analysis of reservoir, vi appare un pi invece di un π. Quindi riguardare con attenzione il ristato finale alla ricerca di errori è importantissimo; errori di battitura ne facciamo tutti, ma siccome le formule sono prive di ridondanza, non si può capire e correggere mentalmente l’errore come si potrebbe spesso fare nel testo.

2.d) Ricordati di non riportare in nessuna formula più cifre significative di quelle che possono essere oggettivamente misurate; ricordati che con le grandezze misurabili anche i “trailing zeros” sono significativi nella parte fratta, mentre i “leading zeros” non sono significativi prima della parte intera; ovviamente prima del separatore decimale ci vuole sempre una cifra, anche se fosse uno zero. Il fatot che tu scriva grandi matrici in notazione scientifica con anche 6 cifre significative è fuori della realtà, anche se dovrebbero essere risultati teorici. Tuttavia le matrici K e b in fondo alla pagina 12 sarebbero più facilmente leggibili se non fossero in notazione scientifica e contenessero le unità di misura.

2.e) Capisco che l’inglese non sia né la tua né la mia lingua madre; ma ci cono alcune espressioni che in inglese sono decisamente diverse; per esempio: In reference to the figure 1 dovrebbe essere With reference to figure 1. Altrove devi stare attento a non confondere big con large; in italiano li tradurremmo entrambi con grande, ma hanno sfumature diverse; cerca bene su un buon dizionario, perché quando passi dall’italiano all’inglese devi usare l’aggettivo appropriato, visto che la corrispondenza non è biunivoca.

Come vedi, quindi, le mie osservazioni, a arte gli errori che ti ho segnalato, sono considerazioni estetiche che possono essere condivise o possono essere considerate insulse; visto che hai chiesto, ti ho dato il mio parere.

Spero di esserti stao utile.

Claudio

marchetto” post=84075Ho una domanda di tipo piuttosto generale: ho scritto per l’università dei report su strutture in calcestruzzo e li ho anche pubblicati sul sito: Pagine pubblicate.
Mi trovo spesso a scrivere testi di questo genere e vorrei migliorarli in futuro (tipograficamente parlando).

Qualche consiglio da darmi su cosa modificare, togliere o aggiungere o ancora fare completamente diversamente?

Buona serata
Marco

Ciao,

oltre ai consigli di @OldClaudio, io mi sentirei di dirti qualcosa a proposito delle immagini. Da un primo sguardo ho visto che hai incluso le tue immagini da file esterni; ecco, porta via un po’ di tempo all’inizio, ma realizzare da soli le immagini (e con la tua tematica è perfettamente fattibile) permette di avere uniformità di font che adesso non c’è nel tuo documento (oltre a migliore qualità eccetera… 😉 ).

Puoi trovare alcuni esempi sulla guida Introduzione all’uso di TikZ in Ingegneria e altri ancora sulla libreria apposita di Francesco: TikZ-mec.

Ciao
Claudio

marchetto” post=84095sto aspettando la pubblicazione di questo argomento su l’Arte, anzi si più o meno quando uscirà?

Ti ringrazio per la fiducia: l’Arte è solo uno dei luoghi dove si può leggere qualcosa su LaTeX. Non è certo il migliore 🙂

Ad ogni modo, prima di vedere qualcosa su TikZ nelle pagine della guida ti dovrai accontentare di un articolino che verrà presentato diciamo tra una quindicina di giorni almeno.

Ciao
Tommaso

Stai scrivendo per una platea anglosassone? Allora ricorda che il separatore decimale è il punto e non la virgola. Se hai usato il pacchetto [tt]siunitx[/tt] sarà facile modificare tutto rapidamente.
Sei tenuto ad usare le norme ISO? Allora dovresti rivedere l’uso dei pedici (ad esempio la g di gas o la g dell’accelerazione di gravità) e del simbolo di differenziale nell’integrale (che invece è corretto nelle equazioni differenziali). Cerca di mantenere la coerenza dei simboli in tutto il documento (ad esempio il raggio della sfera a volte ha il pedice minuscolo, altre maiuscolo).
Visto che si tratta di una relazione tecnica, non capisco tutte quelle equivalenze all’inizio (ad esempio tra centimetri e metri). Chi legge la relazione saprà di certo che 0,2 m sono 20 cm!
Usa il simbolo “circa uguale” quando la corrispondenza in unità di misura differenti non è esatta (es: 45° in radianti).
Ricontrolla le unità di misura: la pressione (del gas) ha il metro quadrato al denominatore, non al numeratore. Questo errore te lo sei portato avanti più di una volta.
Nel primo integrale non si capisce qual è l’argomento del coseno. Usa le parentesi oppure il puntino per la moltiplicazione. Quando puoi, semplifica: \(\frac{1-\cos2\phi}{2}=\sin^2\phi\).
Io eviterei di usare i gradi come argomento delle funzioni circolari.
Quando hai un prodotto di valori di grandezze, usa le parentesi o il puntino per separarle: non attaccare l’unità di misura della grandezza precedente al valore di quella successiva.
Separa maggiormente le righe di sistemi, matrici e vettori per aumentare la leggibilità.
Nella matrice inizierei con eliminare tutte quelle parentesi tonde che (a me) sembrano inutili e occupano spazio. Eventuali soluzioni alternative: a) provare ad utilizzare un simbolo per le espressioni con tre addendi; b) eventualmente ridurre un po’ la dimensione del carattere; c) riscrivere più sinteticamente tutti quei Delta (che hanno il pedice RB in comune).
Nel vettore dei termini noti proverei ad usare i comandi di LaTeX per le parentesi (tranne che nelle funzioni). Ho il sospetto che tu non l’abbia fatto e penso che aumenti la leggibilità.
Come ti è stato suggerito, non usare la notazione scientifica per le matrici e i vettori: porta fuori un coefficiente comune e aggiungi al coefficiente l’unità di misura. Dovresti riuscire a risparmiare anche un po’ di spazio. Quando lo fai, ricontrolla cosa succede agli elementi con quattro zeri decimali.
A pag. 14 c’è un “and” in corsivo più volte.
La sillabazione inglese è diversa da quella italiana. Stai usando [tt]babel[/tt] per la lingua inglese?
A pagina 20 hai moltiplicato metri per gradi sessadecimali e ovviamente non ha senso, ma il risultato invece è corretto (quasi). Qui mi ricollego al discorso di @OldClaudio: è inutile strafare con i decimali quando i risultati sono approssimati in partenza.
Discorso delle unità di misura. Secoli fa avevo l’abitudine di scrivere accanto ad ogni valore la corrispondente unità di misura per verificare nella semplificazione. Poi dal liceo in poi mi hanno scoraggiato e direi quasi minacciato se avessi continuato a farlo, quindi non ti saprei consigliare che strada scegliere; però una cosa è certa: se per ottenere un valore hai bisogno di più passaggi, l’unità di misura va messa (almeno una) alla fine di ogni passaggio. Non ha senso una cosa tipo L=10×5=50 m.

Ciao