Info su relazioni tecniche ingegneristiche

ccccc” post=83997Ciao a tutti!
Sapreste darmi qualche link o consiglio diretto circa la stesura di una relazione tecnica con Latex?

L’argomento è ingegneristico tecnico però in ambito professionale, non accademico…
In pratica si tratta di documentazione da fornire alla committenza per presentare varie domande di concessioni ecc ecc… presso gli enti pubblici preposti (provincia regione e così via…).

Su questo tipo di documenti ci sono regole più o meno standard di “bella presenza” da seguire per ottenere documenti chiari e allo stesso tempo gradevoli?

Se avete qualche consiglio….
Penso anche a qualche template.

Per ora ho gli appunti in un file di testo.
Ho provato a creare un semplice articolo, ma non so se è la strada preferibile. A primo colpo d’occhio mi sà più di libro tipo romanzo…

Vi ringrazio in anticipo! 😀

Ciao,
puoi provare a guardare questo sito: http://www.latextemplates.com
ti avverto però che si tratta per la maggior parte di documenti preparati da autori di lingua inglese, che seguono norme/regole tipografiche diverse da quelle italiane, tuttavia potrebbe essere utile (anche per differenti testi che potresti dover scrivere in futuro).
Saluti

ccccc” post=83997Ciao a tutti!
Sapreste darmi qualche link o consiglio diretto circa la stesura di una relazione tecnica con Latex?

L’argomento è ingegneristico tecnico però in ambito professionale, non accademico…
In pratica si tratta di documentazione da fornire alla committenza per presentare varie domande di concessioni ecc ecc… presso gli enti pubblici preposti (provincia regione e così via…).

Su questo tipo di documenti ci sono regole più o meno standard di “bella presenza” da seguire per ottenere documenti chiari e allo stesso tempo gradevoli?

Se avete qualche consiglio….
Penso anche a qualche template.

Per ora ho gli appunti in un file di testo.
Ho provato a creare un semplice articolo, ma non so se è la strada preferibile. A primo colpo d’occhio mi sà più di libro tipo romanzo…

Vi ringrazio in anticipo! 😀

Ciao ccccc,
mi sento preso in causa visto che scrivo le mie relazioni tecniche nel campo edilizio da diversi anni con LaTeX.
Ho già espresso opinioni in merito sul forum.
Ti dico solo che per quanto riguarda i modelli per le concessioni, partiresti con la cosa più complicata.
In questo caso LaTeX assumerebbe un ruolo di text processor più che di typesetting engine. La difficoltà sta nel fatto che un modello presenta molti campi da gestire ed ogni comune/ente vuole i suoi.
Meglio cominciare con le relazioni tecniche.
Queste sono invece composte con i criteri del professionista ed è qui che LaTeX da un buon contributo:
* ottima coerenza tipografica
* ottimo aspetto tipografico
* induce a concentrarsi sui contenuti, e la struttura stessa dei contenuti.

Prima cose facili, poi cose difficili…
R.

Per cominciare fai una relazione con la classe base article.
Rimanda le cose che ti richiedono troppo tempo per essere risolte.
Poi, verranno le cose più sofisticate…
R.

ccccc” post=84025Classe base article dunque…
Avevo provato anche a creare un documento con la classe “report” a dirla tutta, torno ad article allora.

Per capirci meglio, visto che sono alle prime armi con latex, anche per capire meglio cosa hai in mente tu e cosa dovrei ottenere io.

Non è che in qualche modo potresti esemplificare un documento tipo presente da qualche parte in rete che ti sembra giusto come modello di relazione tecnica?
In alte parole dicevi di aver scritto delle relazioni tecniche con latex. Non è che potresti mostrarne il risultato finale per capire come è impaginato il tutto, insomma come appare poi alla fine?

Ad esempio se uso la classe article liscia ad occhio mi pare che i margini siano un po’ troppo abbondanti… insomma ho qualche dubbio del genere….
Mi aiuterebbe visionarne una che reputi impaginata bene.
Non so eventualmente potresti postarne anche una contenente testo a casaccio, perchè magari il contenuto dei tuoi scritti non è il caso di pubblicarlo… immagino…

Grazie in anticipo ancora! 🙂

Tra article e report non ci sono grandi differenze.
Servono per cominciare. Il percorso che ti ho consigliato è quello che ho fatto io stesso un passo alla volta fino ad una serie di classi personalizzate che comunque non posso divulgare almeno senza autorizzazione.
Fai una traccia con carta e penna di quello che ti sembra un buon ragionamento, meglio se di una relazione reale.
Non credo nelle scorciatoie anche perché l’obiettivo è quello di lavorare con LaTeX in pianta stabile.
Anche stamani ad un convegno qualcuno mi faceva notare che le presentazioni erano in pp e non in LaTeX…
ma a me non importa. Se la strada in cui credo è il buon lavoro, LaTeX è un buon alleato.
R.

ccccc” post=84039

Il percorso che ti ho consigliato è quello che ho fatto io stesso un passo alla volta fino ad una serie di classi personalizzate che comunque non posso divulgare almeno senza autorizzazione.

Se non puoi pubblicare le tue classi personalizzate, a me basterebbe molto meno. 🙂
Per esempio mi farebbe comodo anche un esempio in pdf del risultato finale, come ho detto anche contente testo che nulla ha a che fare con la tua relazione. Tanto per vedere come viene impaginato il tutto.
In ogni caso ti ringrazio per le risposte.

Cerco di spiegare meglio il senso della mia domanda.
Non sono esperto di relazioni tecniche e siccome tempo fà ho partecipato ad uno studio che alla fine ha portato alla stesura di una relazione.
Relazione che non ho scritto io personalmente, ho solo passato il mio pezzo di lavoro a chi poi si è preso a carico l’onere di cucire i vari punti e mettere insieme la relazione completa.
Per lo scopo era stato utilizzato un documento “doc” senza porsi neanche domande o farsi troppi problemi circa l’impaginazione, eventuali standard o regole tipografiche…
Il documento finale mi è parso poco curato, nonostante il contenuto fosse ok e la sua funzione di relazione tecnica ci fosse tutta.

Da questa osservazione mi ero chiesto se non ci fossero soluzioni più adeguate. E sono partito dalla ricerca in rete di esempi di relazioni tecniche nel campo ingegneristico.
Però non ho trovato risultati esaurienti e così mi sono arreso e ho pensato di chiedere qui.
Soprattutto perchè apprezzo la resa che si ottiene grazie all’impiego di Latex, nel senso che secondo me il documento finale appare decisamente più professionale e gradevole.

Quindi rinnovando il grazie per le risposte e i consigli, lascio aperta la domanda.
Se avete sottomano materiale interessante che possa indirizzarmi verso una buona impaginazione quanto più adeguata allo scopo ditemi pure. Anche ovviamente materiale in rete, qualche link e così via sarebbe davvero gradito! 😉
Alla prossima 😀

Purtroppo non posso neanche rilasciare esempi in pdf.
Ma se tu lasci aperta la domanda mi sento di farne una io a te:
Sei abituato a lavorare su una griglia già fatta?
Non capisco perché non provare a partire “from scratch”.
È semplicissimo: ecco il template:
`% modello di relazione versione 0.0.1 del 10/04/2013
% !TEX encoding = UTF-8
% !TEX program = pdflatex
% !TEX root = nomefile.tex

% ps. sostituire alla riga precedente ogni volta nomefile, con il nome effettivo del sorgente

\documentclass[a4paper]{article}

% pacchetti di base per codifiche (da non cambiare, neppure l'ordine):
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage[italian]{babel}

% pacchetti “tipografici”

% impostazione del layout di pagina
% il manuale si apre con il comando da console: > texdoc geometry
% ma all'inizio vanno benissimo le impostazioni di default
\usepackage{geometry}

% personalizzazione delle caption per tabelle e figure
% il manuale si apre con il comando da console: > texdoc caption
\usepackage[margin=6pt,
font=small,
labelfont=bf,
labelsep=endash]{caption}

% pacchetti applicativi:

% unità di misura
\usepackage[output-decimal-marker={,}]{siunitx}
% esempi di u.m. (il manuale si apre con > texdoc siunitx):
% \SI{100.00}{m^2}
% \si{MPa}

\begin{document}

% sommario
% occorre compilare due volte
\tableofcontents

% sezioni
\section{Titolo}
\label{sec:tit}

% scrivere qui il testo della sezione

\section{Altro titolo}
\label{sec:titaltr}

% scrivere qui il testo della sezione

% se si lavora in gruppo inserisco gli altri sorgenti prodotti così
% \input{nomefile}

\end{document}
`

R.
Ps. recentemente ho dovuto fare l’ispettore alla validazione di un progetto abbastanza complesso.
… la documentazione era un collage di materiale tanto da essere costretto a dire n.c. …

ccccc” post=84052L’idea che avevo in mente era proprio quella di farmi una griglia già fatta, semplice tipo il tuo template e quindi aggiungervi di volta in volta il testo che trovo utile buttare giù in file di testo semplice (anche perchè così se mi servisse inviarlo ad altri per modifiche ecc è la cosa più semplice… al limite posso anche copiarlo in un documento tipo “doc” ed inviarlo ad altri che potranno editarlo aggiungendovi pezzi ecc….

Non usando spesso latex mi è scomodo ricordare i comandi per inserire immagini, tabelle ecc. Per cui avere un template commentato come hai proposto tu è una manna. Non avendo chissà quali esigenze, risparmio tempo e mi limito ad adeguare il testo proveniente dal “.txt” alle regole di latex, tipo aggiungendo le linee vuote per i periodi, aggiungendo il comando per inserire un elenco e così via.
Fatto il tutto metto i comandi per inserire eventuali tabelle ed immagini.

Capisci bene che se posso avere tutti quei comandi commentati nel template, diventa parecchio più sbrigativa l’operazione.
L’alternativa è cercare i vari comandi (che da una volta all’altra dimentico) nella documentazione (tipo Arte di scrivere con Latex del Pantieri per esempio). E questo comporta inevitabilmente una discreta perdita di tempo.

Il template che hai posta come esempio, già mi dà un input per ottenere qualcosa di più rispetto alle mie scarse conoscenze…
Quindi grazie mille! 🙂
Alcuni “todo” per completarlo… dico la mia, se avete commenti idee ecc, non esitate ad aggiungere
1- devo capire meglio come fare a impostare le section in modo che inizino a inizio pagina. Mi sembra più pulita come soluzione (sbaglio?)
2- come aggiungere una pagina iniziale (tipo copertina) in cui mettere Titolo autore ecc. In pratica vorrei che sulla prima pagina ci fosse solo il titolo, autore e poche altre info eventuali. Poi nella/e pagina/e successiva/e l’indice che rimandi alle varie section. Infine all’inizio della pagina successiva all’indice l’inizio dell varie sections.
Cosa ne pensate? e come si possono ottenere?

3- aggiungerei al template i comandi commentati per l’inserimento tabelle e immagini.

Per il momento mi fermo qui.
Alla fine proverò a postarvi un link al risultato finito così che possiate darmi un’opinione.

Ciao,
per il punto 2: se non ti va bene l’opzione [tt]titlepage[/tt]? ([tt]\documentclass[titlepage,…]{article})[/tt] allora devi impostare una pagina vuota da zero, secondo me, utilizzando i comandi di spaziatura verticale tipo: [tt]\vspace{5ex}[/tt], ecc…
Cerca di usare quanto più possibile unità di misura che siano proporzionali al font, a tale proposito e anche per avere qualche nozione base di tipografia, leggiti il secondo capitolo della guida GuIT.
Saluti

L’opzione title page serve per far sì che con la classe article (dove di default il titolo dell’articolo non ha una pagina tutta per sé) il titolo venga composto in una pagina iniziale, una specie di frontespizio.

Il linguaggio LaTeX, le sue opzioni, i suoi ambienti, eccetera sono riportati nena guida tematica LaTeX Reference Manual commentato, liberamente tradotto in italiano e commentato per aggiungere le cose che oggi si possono fare con i vari file di estensione e che nel 1994 non si potevano fare.

Te lo suggerisco, perché se vuoi creati un template adatto alla relazione tecnica, avrai bisogno di ricordare e di avere ben presenti tutti i comandi del mark-up di LaTeX.

Scarica quella guida tematica dalla sezione Documentazione di questo sito.

Per il futuro, giá che ci sei, scarica anche la guida tematica per programmare le classi di documento, sempre di Claudio.
R.