Tateo’s Interdisciplinary Lifelong Learning Project
T I L L L
LEARNING - SHARING - NETWORKING
Learning, knowledge sharing and Communities engagement about:
Artificial Intelligence, Extended / Augmented / Virtual / Mixed Reality (XR/AR/VR/MR), Automation, Electronics, Computer Science and Information Technology, Mobile Technologies, Problem Solving & Innovation, Readings, Social Media, Digital Modeling and Simulation, Computer Vision, Work and Soft Skills, Railway.
by Tateo Giovanni Battista
_____________________________
LEARNING
WORK SKILLS
Technical writer.
Redattore di documenti tecnici.
We are talking about:
#competences #workSkills #technicalProposal #technicalWriter #TILLL #TateoBlog
Summary. Analysis of the fundamental role that communication plays in the scientific field. In particular, we will analyze the canons that must be followed in scientific writing, an activity that has been accompanying me daily in the workplace, since I have held the role of technical proposal.
Analisi del ruolo fondamentale che la comunicazione assume in ambito scientifico. In particolare analizzeremo i canoni che occorre seguire nella scrittura scientifica, attività quest'ultima che mi sta accompagnando quotidianamente sul posto di lavoro, da quando ricopro il ruolo di technical proposal
~ o ~
You are >>> HERE <<< within the TILLL project.
Ti trovi >>> HERE <<< all'interno del progetto TILLL.
§1. Technical writing.
La scrittura tecnica.
In technical and scientific fields, such as engineering, robotics, medicine, finance and electronics, it often happens to have to explain very specialized and complex systems, techniques and procedures, and to have to do it to a competent public or not. of the topic.
In campi tecnici e scientifici, come per esempio l'ingegneria, la robotica, la medicina, la finanza e l'elettronica capita spesso di dover spiegare sistemi, tecniche e procedure molto specializzate e complesse, e di doverlo fare ad un pubblico competente o meno dell'argomento.
When content is inherently complex, technical writers make it more readable, making it easier to understand the content. They take care of every detail of the content, down to the smallest details: its composition, the use of the most appropriate words and vocabulary and even punctuation. No detail is too small to improve.
Quando i contenuti sono per propria natura complessi, gli scrittori tecnici li rendono più leggibili, facilitandone la comprensione dei contenuti. Essi curano ogni particolare del contenuto, fino ai minimi dettagli: la sua composizione, l'uso delle parole e dei vocaboli più appropriati e persino della punteggiatura. Nessun dettaglio è troppo piccolo per essere migliorato.
The work of the technical writer is important and indispensable for the company because making the communication process towards the customer more efficient, and therefore making sure that the customer understands the real value of the product, protects and enhances the work of all those who they work.
Il lavoro del technical writer è importante ed indispensabile per l'azienda perché rendendo più efficiente il processo di comunicazione verso il cliente, e quindi facendo in modo che il cliente comprenda il valore reale del prodotto, protegge e valorizza il lavoro di tutti quelli che ci lavorano.
“Technical writing is a continuous process of learning, carefully gathering, sifting, organizing, and assessing, all while trying to craft something that makes sense for a user.”
"La scrittura tecnica è un processo continuo di apprendimento, raccolta accurata, vagliatura, organizzazione e valutazione, il tutto mentre si cerca di creare qualcosa che abbia senso per un utente".
(cit. Krista Van Laan, The Insider’s Guide to Technical Writing)
The fundamental purpose of technical writing is not the simple presentation of information or thought, but rather their real communication, ie their understanding. No matter how pleasant and correct is the form of the sentences and paragraphs into which the author has converted the data and the thought; it only matters if the majority of the reading audience accurately perceived what the author had in mind. Obviously also the aesthetics and a good composition of the piece contribute to its understanding. However, these two aspects remain vain and ends in themselves if they are not corroborated by an adequate communicative capacity.
Lo scopo fondamentale della scrittura scientifica (technical writing in lingua anglosassone) non è la semplice presentazione di informazioni o del pensiero, ma piuttosto la loro comunicazione reale, ossia la loro comprensione. Non importa quanto piacevole e corretta sia la forma delle frasi e dei paragrafi in cui l'autore ha convertito i dati ed il pensiero; importa solo se la maggior parte del pubblico di lettori ha percepito con precisione ciò che l'autore aveva in mente. Ovviamente anche l'estetica ed una buona composizione del brano concorrono alla sua comprensione. Tuttavia questi due aspetti restano vani e fini a se stessi se non sono corroborati da una adeguata capacità comunicativa.
We can therefore basically distinguish three aspects:
Possiamo quindi distinguere fondamentalmente tre aspetti:
We are talking about: #technicalWriting #communication
References to useful sources for further information:
Riferimenti a fonti utili per approfondimenti.
1. What is Technical Writing? A Beginner’s View
2. The Insider’s Guide to Technical Writing, Krista Van Laan
-----------------------------------------
Last updated August 13, 2022
~ o ~
§2. Legibility.
Chiarezza.
Appearance of the writing in terms of the type of font or calligraphy and in the arrangement (layout) of the text within the page; for example, if a manuscript is illegible, such as certain medical prescriptions, the understanding of the passage is compromised regardless of the content of the written message and how effective it can be in communicating a concept. As for the type of character (font) of the printed text, it should be noted that reading can be facilitated by the use of serif characters which are orthogonal elongations at the ends. Examples are the Palatine Linotype, the Georgia and the Bookman Antiqua.
Aspetto della scrittura in termini di tipo di carattere o calligrafia e nella disposizione (layout) del testo all'interno della pagina; per esempio se un manoscritto è illeggibile, come ad esempio certe ricette mediche, la comprensione del brano è compromessa a prescindere dal contenuto del messaggio scritto e da quanto possa essere efficace nel comunicare un concetto. Per quanto riguarda il tipo di carattere (font) del testo stampato, si osservi che la lettura può essere facilitata dall'utilizzo di caratteri con grazie (serif) che sono degli allungamenti ortogonali in corrispondenza delle estremità. Esempi sono il Palatino Linotype, il Georgia ed il Bookman Antiqua.
§3. Readability.
Leggibilità.
Quality of the composition and construction of the piece; the care in the composition of the passage can make the reading pleasant and entice the reader to get to the end of the passage. Otherwise a cumbersome reading will discourage the reader by encouraging him to stop reading.
Qualità della composizione e costruzione del brano; la cura nella composizione del brano può rendere la lettura piacevole ed invogliare il lettore ad arrivare in fondo al brano. Diversamente una lettura macchinosa scoraggerà il lettore invogliandolo ad interrompere la lettura
§4. Comprehensibility.
Comprensibilità.
Capacity and effectiveness of the communication of the message that we wanted to convey through the written piece. Given the satisfaction of the first two aspects, it is necessary to verify whether the written message is able to effectively express the concept that we have proposed to transmit.
Capacità ed efficacia della comunicazione del messaggio che si è voluto trasmettere attraverso il brano scritto. Premesso il soddisfacimento dei primi due aspetti occorre verificare se il messaggio scritto riesce ad esprimere in modo efficace il concetto che ci si è proposti di trasmettere.
"The fascination of the technical writer profession lies in communicating,
in being able to create something for someone who, thanks to you,
will be able to do something complex and concrete,
without difficulty."
"Il fascino del mestiere del technical writer sta nel comunicare,
nel poter creare qualcosa per qualcuno che, grazie a te,
riuscirà a fare qualcosa di complesso e di concreto,
senza difficoltà."
(cit. Vilma Zamboli, Writec)
~ o ~
§5. References to useful sources for further information.
Riferimenti a fonti utili per approfondimenti.
Listed below are some references to sources (websites, videos and book) that I have consulted during the writing of this article, and that you could also use to learn more about the topics covered in this article.
Di seguito sono elencati alcuni riferimenti a fonti (siti web, video e libri) che ho consultato durante la stesura di questo articolo e che potresti utilizzare anche tu per approfondire gli argomenti trattati in questo articolo.
1. STC ( Society for Technical Communication ). The Society for Technical Communication is a professional association dedicated to the advancement of technical communication. Technical communicators research and create information about technical processes or products directed to a targeted audience through various forms of media. 2. Handbook for writing proposal, Robert J. Hamper and L. Sue Baugh
§6. More generally about Technical Proposal.
Più in generale a proposito della redazione di proposte tecnica.
Technical writing is only one of the skills needed to carry out the technical proposal task. If you are interested in knowing what this latter skill consists of, I invite you to read the following page of my electronic diary that I have dedicated to this purpose.
La scrittura scientifica è solo una delle competenze necessarie per svolgere il compito di technical proposal. Se ti interessa conoscere in cosa consiste quest'ultima competenza ti invito a leggere la seguente pagina del mio diario elettronico che ho dedicato a questo proposito.
The business opportunity analysis & Technical proposal writing.
L’analisi di Opportunità Commerciali e la scrittura di Proposte Tecniche.
§7. Stay up to date.
Rimani aggiornato.
If you are interested in the topics covered in the current article and want to be informed about my most recent updates dealing with them, then I invite you to register on the following Facebook page and Pinterest dashboard which I dedicated specifically for sharing the most recent changes made to the corresponding thematic area of TILLL~Learning (>). Se sei interessato agli argomenti trattati nell'articolo corrente e vuoi essere informato sui miei aggiornamenti più recenti che trattano di essi, allora ti invito a registrarti sulla seguente pagina Facebook e bacheca Pinterest che ho dedicato appositamente per la condivisione delle modifiche più recenti apportate all'area tematica corrispondente di TILLL~Learning (>). "Skills by TILLL" on Facebook (link) "Skills by TILLL" on Pinterest (link) ~ o ~
§8. Let's keep in touch.
Teniamoci in contatto.
I hope you enjoyed this article, belonging to the Learning (>) section of the Tateo's Interdisciplinary Lifelong Learning (TILLL) project (>), and that the notes and observations I gathered within it meets your interests. If you want stay tuned with the TILLL project evolution, then I invite you to follow the next upgrades that are published on the TILLL's Blog and on the social media pages dedicated to the TILLL community. Spero che questo articolo, appartenente alla sezione Learning (>) del progetto Tateo's Interdisciplinary Lifelong Learning (TILLL) (>), ti sia piaciuto e che le note e le osservazioni che ho raccolto al suo interno soddisfino i tuoi interessi. Se vuoi rimanere aggiornato sull'evoluzione del progetto TILLL, allora ti invito a seguire i prossimi aggiornamenti che vengono pubblicati sul Blog di TILLL e sulle pagine social dedicate alla community TILLL.
(>) Tateo-Blog, official blog of TILLL project
(>) LinkedIn page dedicated to TILLL project
(>) Facebook page dedicated to TILLL project
(>) Twitter account dedicated to TILLL project
(>) Pinterest account dedicated to TILLL project
(>) Instagram account dedicated to TILLL project
§9. Something about me, the founder and author of Tateo~Blog Project.
Qualcosa su di me, il fondatore e sull'autore del progetto Tateo~Blog.
First of all, thank you for visiting one of the pages of my project for Interdisciplinary Continuous Learning (TILLL which stands for Tateo's Interdisciplinary LifeLong Learning), of which I am the founder and author.
My name is Giovanni Battista Tateo (shortly Bat).
Innanzitutto ti ringrazio per aver visitato una delle pagine del mio progetto per l'Apprendimento Continuo Interdisciplinare (TILLL che sta per Tateo's Interdisciplinary LifeLong Learning), di cui io sono lil fondatore e l'autore.
Mi chiamo Giovanni Battista Tateo (brevemente Bat).
The Tateo~Blog (link) is an integral part of the project constitutes the means of sharing all updates.
I was initially an Information Technology expert, and later I became an electronic engineer, specializing in industrial Automation. I'm passionate about Artificial intelligence, Virtual Reality, Simulation, and I'm an expert in Artificial Vision applied to industrial Automation. Currently, and starting four years ago, I am employed as a Proposal Engineer at Mer Mec S.p.A. (:::) company. Previously, starting in 2004, I was employed, always at the same company, as a Designer of Artificial Vision Systems and Image Processing Algorithms, applied in particular to Railway Diagnostics. I am a supporter and promoter of Lifelong Learning, Social Networking and Knowledge Sharing by means of the web. If you want more details about me, visit the About Me (:::) page.
Il blog Tateo~Blog (link) è parte integrante del progetto costituisce il mezzo di condivisione di tutti gli aggiornamenti.
Sono stato in principio un esperto di Informatica, e in seguito sono diventato un Ingegnere Elettronico, specializzato in Automazione Industriale. Sono un appassionato di Intelligenza Artificiale, Realtà Virtuale, Simulazione, e sono un esperto di Visione Artificiale applicata all'Automazione Industriale. Attualmente, ed a partire dall'anno 2016, sono impiegato come Proposal Engineer presso la società Mer Mec S.p.A. (:::). Precedentemente, a partire dal 2004, sono stato impiegato, sempre presso la stessa società, come Progettista di Sistemi di Visione Artificiale e di Algoritmi di Elaborazione delle Immagini, applicati in particolare alla Diagnostica Ferroviaria. Sono un sostenitore e promotore dell'apprendimento permanente, dei social network e della condivisione delle conoscenze tramite il web. Se vuoi ulteriori dettagli su di me, visita la pagine About Me (:::).
Contact me. Following you can find my personal references that you can use if you want to contact me directly, and the links to my social accounts that you can use to follow me or to keep in touch with me by means of social media networks.
Contattami. Per chi scrive non c’è soddisfazione maggiore di quella che si prova sapendo di essere stato letto e di aver ispirato e fornito esperienze e pratiche utili. Per cui, chiunque contattarmi utilizzando uno dei riferimenti seguenti. Sarò felice di poterti leggere e di confrontarmi con te, di poter leggere le tue critiche, i tuoi suggerimenti, le tue riflessioni e, spreto anche i tuoi complimenti.
Giovanni Battista Tateo (aka Bat)
- e-mail: tateogb@libero.it (send e-mail)
- phone / WhatsApp : (+39) 388 8419726
- LinkedIn account (link)
- Facebook account (link)
- Twitter account (link)
- Instagram account (link)
- Pinterest account (link)
-----------------------------------------
Originally published July 28, 2016.
Updated August 13, 2022.
into the Learning section of
TILLL
the Lifelong and Interdisciplinary Learning project of Giovanni Battista Tateo
Commenti
Posta un commento