Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Comunicazione Tecnica 1

524 views

Published on

Introduzione alla Scrittura Tecnica, Technical Writer, Strategie per Technical Writing.

Published in: Education, Business
  • Be the first to comment

Comunicazione Tecnica 1

  1. 1. Technical WritingCOMUNICAZIONE TECNICAParte I – Caratteristiche della Documentazione TecnicaDicembre 2010 1
  2. 2. Contenuti Introduzione alla Scrittura Tecnica Struttura e Contenuti dei Documenti “Tecnici” 2
  3. 3. CitazioneParte del materiale è tratto dal corso:MIT OpenCourseWare | 21W.783 Science and EngineeringWriting for Phase II, Fall 2002 |Prof. Prof. David Custer, course materials for 21W.783Science and Engineering Writing for Phase II, Fall 2002MIT OpenCourseWare (http://ocw.mit.edu), MassachusettsInstitute of Technology.Downloaded on 20 October 2003 3
  4. 4. Scrittura TecnicaIntroduzione 4
  5. 5. Scrittura TecnicaTechnical Writing è qualsiasicosa che non si intende siaromanzesca, immaginaria,narrativa” 5
  6. 6. Obiettivi della sessione• Identify the key elements of technical writing.• Describe the nature of technical writing.• Identify the characteristics of effective technical writing.• Identify the steps in the writing process.• Identify some tips to help your documents. 6
  7. 7. Scrittura Tecnica vs. AccademicaCaratteristiche Scrittura Accademica Scrittura TecnicaScopo Dimostrare la Ottenere la realizzazione conoscenza del tema di qualcosaConoscenza Inferiore al docente Superiore a quella deldel tema che deve valutare lettorePubblico Docente Parecchie personeCriteri per la Profondità, logica, Organizzazione delle ideevalutazione chiarezza, unità e chiara e semplice grammatica 7
  8. 8. Consider These Statements….• Looking into the azure blue sky one could see the golden orb of the sun slip gently beneath the western sky.• The sun set in the west. 8
  9. 9. Technical Writing_Definizione 1“Technical writing conveys specific information about a technical subject to a specific audience for a specific purpose …The words and graphics of technical writing are meant to be practical: that is, to communicate a body of factual information that will help an audience understand a subject or carry out a task.” Michael H. Markel Director of Technical Communication Boise State University 9
  10. 10. Technical Writing_Definizione 2Prendere un tema complicato e trasformarloin una informazione facile-da-comprendere per il lettore/ utente. 10
  11. 11. Technical Writing_Definizione 3Processo problem-solving caratterizzato da questielementi / caratteristiche: Tema Tecnico Problema di Comunicazione Comunicatore, scopo, lettori/uditorio Informazioni precise e accurate Organizzazione e presentazione delle informazioni 11
  12. 12. Technical Writing_Elementi I• Technical subject matter -- peculiar to or characteristic of a particular art, science, trade, technology, or profession• Communication problem -- recognized and accurately defined in the communication context• Communicator, purpose, and audience -- once established, these elements are the beginning of a solution to the communication problem 12
  13. 13. Technical Writing_Elementi II• Accurate, precise information -- discovering information needed to solve problem through thinking, study, investigation, observation, analysis, experimentation, and measurement• Arrangement and presentation of information -- achieving the writer’s purpose in a clear, useful, purposeful way 13
  14. 14. Che cosa producono iTechnical Writer? User’s manuals System manuals Step-by-step procedures On-line help Training manuals Quick-reference guides How-to video scripts. I Technical Writers conoscono … i lettori, gli obiettivi, come scrivere con semplicità, direttamente, e in modo conciso. 14
  15. 15. Technical Writers_Caratteristiche• Metodico• Organizzato La scrittura tecnica• Obiettivo eccellente trasmette una impressione globale di• Centrato sui lettori autorità, accuratezza,• Onesto completezza, e di lavoro• Critico onesto.• Informato• Risoluto, deciso 15
  16. 16. Struttura e ContenutiCaratteristiche 16
  17. 17. Scrivere è un processoScrivere bene significa, sia produrre undocumento adeguato, sia attivare unaserie di azioni con l’obiettivo di produrredocumenti conformi alle specifiche.Processi: • pianificazione, • organizzazione, • scrittura, • revisione, • editing, e • riscrittura. 17
  18. 18. Scrivere è un processocollaborativo Scrivere migliora con la pratica. • Feedback on this writing produces better writing and better writing habits. Scrivere è una attività collaborativa. • Writing is a collaboration between the writer and the audience. Both expect cooperation from the other. • Without this cooperation, nothing is communicated. • Writing can also be a collaboration among writers working together on a common task. 18
  19. 19. Complessità EOQ PM ROP Lean MRP Kanban MRP II Kaizen ERP ... TOC JIT TW 19
  20. 20. Gestione della Complessità ISemplificazione -- Like "the force, simplificationhas a light and a dark side.PrioritizzarePratica / Iterazione -- iteration is importantbecause the drafting process transforms the ideaas understood by the author into an idea that canbe understood by the reader. 20
  21. 21. Gestione della Complessità IIStruttura -- For technical documents, structureincreases the ease of finding and absorbinginformation.Pianificazione -- Planning is the definition ororganization of structure.Astrazione -- Abstraction is a very effectivemethod of simplification.Collaborazione -- Balance collaboration withefficiency. 21
  22. 22. Technical Writing_Natura• Scopo: spelled out in the opening paragraphs• Vocabolario: typically specialized• Frasi: highly specific and fact filled• Gergo: typically present in specialized terminology, definitions, signs, symbols, and formulas• Grafici & tabelle: reinforces and/or expands upon surrounding prose• Documentazione: appears in text & bibliographies 22
  23. 23. Technical Writing_Caratteristiche Gergo e abbreviazioni Grafici (tabelle, grafici, figure) ed Equazioni Enfasi sulle funzioni rispetto l’intrattenimento I Documenti non devono essere letti dalla prima all’ultima pagina I Documenti possono essere utili anche solamente a una udienza ristretta 23
  24. 24. Technical Writing_Operatività I Documenti sono altamente operativi I Documenti Tecnici hanno una data di consegna definita I Prodotti devono essere spediti con la documentazione Le relazioni tecniche e/o scientifiche per congressi/ conferenze devono essere inviate in tempo per essere pubblicate. 24
  25. 25. Technical Writing_EfficaciaLe quattro “C”: • Chiarezza – facilmente comprensibile dal pubblico designato • Comprensività – tutte le informazioni necessarie sono presenti • Concisione – chiara senza eccesso di verbosità • Correttezza – rispetta la grammatica e segue le convenzioni 25
  26. 26. Technical Writing_Qualità I• Consegna alla data prevista, o prima• Impressive when flipped through• Il documento: Contains necessary front matter discloses purpose and scope Fornisce informazioni essenziali, clearly written, free of padding Include una sintesi e/o conclusioni È progettato per essere letto in modo selettivo (interessi/ necessità) 26
  27. 27. Technical Writing_Qualità II• Uso di tabelle e grafici per presentare e chiarire i contenuti• Uso di un piano razionale, facilmente percepibile, rivelato dall’indice dei contenuti e dai titoli dei capitoli/ paragrafi• Reads coherently and cumulatively• Anticipa le domande del lettore e risponde alle stesse 27
  28. 28. Struttura dei Documenti• Sintesi / Summary -- a brief summary of the whole• Introduzione / Introduction -- defines your problem.• Contesto / Background -- shows how your solution is likely to solve the problem.• Metodi / Methods -- outlines your solution• Conclusioni / End stuff -- details, schedule, costs 28
  29. 29. Struttura della Proposta/Proposal• Because text is linear and finite, it has a beginning a middle and an end. This structure is maintained at every level of text: the word, the sentence, the paragraph, the section, and the document as a whole.• Many structures are possible. The right organization is the one that best fits the purpose.• Give every document a title. In the introduction section of longer documents, be sure to introduce the structure and content of the rest of the document.• Struttura della Proposta• Struttura del Rapporto 29
  30. 30. Struttura del Rapporto/ Report• Sintesi/Abstract -- a summary of the problem, methods, results, and conclusions.• Introduzione/Introduction -- defines your problem.• Contesto/Background -- shows how your solution is likely to solve the problem.• Metodi/ Methods -- outlines your solution.• Risultati/ Results• Conclusioni/ Conclusions 30
  31. 31. Please don’t forget to fill outthe evaluation forms!THANK YOU FOR YOUR TIME! 31

×