Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle peculiarità del mercato USA.
Report sul libro di Lars Kothes, Grundlagen der technischen Dokumentation, Springer-Verlag, Berlin, Heidelberg, 2011.
Con una nota sulle specificità della gestione modularizzata dei contenuti (tramite sistemi di content management [CMS]) in termini di metadati, stato di avanzamento del contenuto, revisione, riferimenti incrociati e riuso.
Attività normativa nel campo delle Additive Manufacturinguninfoit
Intervento UNINFO al Convegno di AITA 3D a Torino 10 marzo 2016
Progettiamo Additivo! – Aspetti di prodotto, processo e gestione per le tecnologie additive, organizzato da AITA-ASSOCIAZIONE ITALIANA TECNOLOGIE ADDITIVE in collaborazione con il Centro Estero Internazionalizzazione Piemonte.
http://www.aita3d.it/?p=2026
Attività normativa nel campo delle Additive Manufacturinguninfoit
Intervento UNINFO al Convegno di AITA 3D a Torino 10 marzo 2016
Progettiamo Additivo! – Aspetti di prodotto, processo e gestione per le tecnologie additive, organizzato da AITA-ASSOCIAZIONE ITALIANA TECNOLOGIE ADDITIVE in collaborazione con il Centro Estero Internazionalizzazione Piemonte.
http://www.aita3d.it/?p=2026
Presentazione a supporto dell'intervento di Claudio Rosso, (Coordinatore del GL 03 “Misurazione della circolarità” della
UNI/CT 057) al webinar Standard circolari:i progetti UNI e ISO a supporto dell’economia circolare del 9 marzo 2021
Lettera aperta per creare un terreno comune di condivisione e collaborazione favorevole alla crescita del settore della comunicazione tecnica.
Gli obiettivi del common ground sono molteplici, più o meno ambiziosi: indurre gli attori a uscire dai propri confini per condividere esperienze e conoscenze; favorire la mappatura delle criticità, nonché l'individuazione e la diffusione della conoscenza delle soluzioni esistenti; formare una rete di imprese e associazioni finalizzata a ideare e sviluppare metodi e strumenti innovativi.
Presentazione a supporto dell'intervento di Elena Mocchio Responsabile Innovazione e Sviluppo UNI al webinar "IL MONITORAGGIO DELLA QUALITÀ DELL’ARIA NEGLI EDIFICI SCOLASTICI" del 25 novembre 2021
Fatturare Digitale - Come gestire in modo semplice la Fatturazione Elettronica.Fatturare Digitale
Relatore: Angela Tassone, Head Of Marketing & Communications in IWS Consulting
Durante il webinar sarà presentata una metodologia di lavoro, analisi e processi documentali che risponde alle attuali esigenze di gestione della Fatturazione Elettronica, attiva e passiva, con un proprio modulo e sistema automatizzato che include anche la conservazione digitale a norma.
Perché e come utilizzare un CMS per realizzare documentazione tecnica e di pr...KEA s.r.l.
I contenuti sono un capitale dell’azienda: vediamo come gestirli in modo ottimale e massimizzarne la resa, rispondendo in modo adeguato ai bisogni informativi dei destinatari e attivando nuovi servizi knowledge intensive per utenti interni, forza vendita, partner e rivenditori, installatori, utilizzatori, manutentori, ecc.
Guida pratica a come trasformare il contenuto da costo in risorsa a supporto della strategia aziendale.
Parcel XDoc consente di creare, gestire, raggruppare, tracciare la storia e la
distribuzione di documenti sia appartenenti a cicli documentali inerenti ai dossier
sia ad altri tipi di documenti. E’ possibile sottoporre contenuti controllati relativi
alle richieste di autorizzazione, come ad esempio quelle di nuovi farmaci (NDA)
agli enti normativi governativi preposti.
Il sistema gestisce il processo di presentazione delle richieste in conformità alle
normative, attraverso la specifica eCTD (Electronic Common Technical Document)
definita dall'ICH (International Conference on Harmonization) per lo scambio dei
dati tra aziende farmaceutiche ed enti normativi.
Edifici antisismici in Calcestruzzo Armato - 0 Obiettivi del capitolo 10 dell...Eugenio Agnello
Slide estratte da una presentazione del prof. Aurelio Ghersi, ordinario di ingegneria strutturale dell’Università di Catania, in occasione di un convegno “Edifici antisismici
in Calcestruzzo Armato, aspetti strutturali e geotecnici secondo le NTC 2008” che si è svolto nel Dicembre 2010 ad Acireale (CT).
NTC08 Alcuni punti chiave,
Principi e regole applicative,
Cambio di mentalità,
Principi come distinguerli,
La norma è perfetta?,
Elementi principali e secondari,
Gerarchia delle resistenze,
Elenco Elaborati,
Uso Codici di calcolo,
Analisi, verifiche e accettazione dei risultati,
Per il progettista,
Per il controllo del progetto,
Passi nella formulazione del giudizio,
Esame della struttura, modello ed analisi,
Previsione numerica del comportamento,
Esame dei risultati di calcolo,
Esame delle armature.
Slide a supporto dell'intervento di Alessandro Delvecchio - Ufficio Sviluppo Progetti UNI - al convegno "Tecnologie di realizzazione delle infrastrutture interrate a basso impatto ambientale" del 12 luglio 2017, organizzato da UNI, IATT e Unindustria
Lo stato dell' arte sulla documentazione dei progetti ICTMatteo Gentile
Ogni progetto informatico è sicuramente incompleto fino a quando non viene corredato da una documentazione esauriente. In un progetto informatico la documentazione è presente in tutte le fasi, dalla raccolta dei requisiti, passando per la documentazione di analisi e tecnica di implementazione, fino ad arrivare alla documentazione per l’utente finale.
Quali documenti è opportuno generare in un progetto ?
La documentazione di progetto va generata all’inizio o alla fine ?
Come fare a tenere sempre aggiornata la documentazione quando i requisiti o le implementazioni cambiano ?
Che standard usare per creare una buona documentazione di un progetto informatico ?
Recentemente c’è stata un'ampia diffusione delle metodologie Agili. E’ vero che non è prevista documentazione ?
Questo evento nasce per rispondere a queste domande e per mostrare attraverso un esempio pratico come introdurre la documentazione in un progetto che usa le metodologie Agili.
Modello economico del Cloud, Knowledge Intensive Business Servicesciii_inginf
Modello economico del Cloud. L’importanza dell’industria dei servizi, i KIBS (Knowledge Intensive Business Services).
Presentazione a cura dell'Ing. Bruno Lo Torto
Consigliere Centro Studi del Consiglio Nazionale Ingegneri
http://www.centrostudicni.it/
Argo CCMS: come usare al meglio i file di configurazione per export in Word, ...KEA s.r.l.
Alla scoperta di uno strumento di Argo CCMS molto potente, che non sempre riceve la giusta attenzione.
Che cosa sono e a che cosa servono i file di configurazione?
I file di configurazione «registrano» tutte le impostazioni che eseguiamo durante una procedura di esportazione (es. in Word, Excel o XML).
Richiamando in seguito un file di configurazione ripetiamo la procedura di esportazione, applicando in modo automatico le impostazioni salvate... senza doverci pensare più!
Perché i file di configurazione sono utili?
I file di configurazione sono utili perché rendono la procedura di esportazione più veloce, certa e replicabile da ogni operatore.
Suggerimento! A questo scopo possiamo creare, per esempio, file di configurazione specifici per modello e versione, configurazione o matricola della macchina, per cliente, per lingua, per destinatario...
Dialogare con le macchine in linguaggio naturale... Finalmente! Ma ci voleva ...KEA s.r.l.
La storia del Natural Language Processing (NLP) parte negli anni Cinquanta del secolo scorso, ma fino a una decina di anni fa traduzioni automatiche, chatbot e assistenti vocali erano perlopiù fonte di ilarità o frustrazione, mentre ora - superato il magico stupore iniziale - dialogare in linguaggio naturale con una macchina è una comune esperienza quotidiana - che sia Google Translate, Alexa, ChatGPT o il chatbot di un sito, ecc. Come dire: “Finalmente le macchine hanno imparato a parlare la nostra lingua! Ci voleva tanto?”.
Sì, tantissimo: il linguaggio è un fenomeno molto complesso - perché intrinsecamente legato all’umana esperienza del mondo, a livello personale, relazionale, socio-culturale e storico -, un fenomeno che padroneggiamo con naturalezza, ma che abbiamo dovuto anzitutto capire come rendere “comprensibile” alle macchine. Padroneggiare il linguaggio non significa solo conoscere il significato delle parole e le regole sintattico grammaticali di una lingua, significa anche e soprattutto come generare senso mediante questi utensili linguistici. La questione centrale è come rendere “comprensibili” alle macchine i sistemi di produzione di senso in assenza del fatto che le macchine possano basarsi sul contesto esperienziale e relazionale che guida l’umana comprensione delle eccezioni, delle ambiguità, della semantica e della pragmatica della lingua.
More Related Content
Similar to Documentazione tecnica e di prodotto: linee guida europee, leggi e norme; peculiarità del mercato USA
Presentazione a supporto dell'intervento di Claudio Rosso, (Coordinatore del GL 03 “Misurazione della circolarità” della
UNI/CT 057) al webinar Standard circolari:i progetti UNI e ISO a supporto dell’economia circolare del 9 marzo 2021
Lettera aperta per creare un terreno comune di condivisione e collaborazione favorevole alla crescita del settore della comunicazione tecnica.
Gli obiettivi del common ground sono molteplici, più o meno ambiziosi: indurre gli attori a uscire dai propri confini per condividere esperienze e conoscenze; favorire la mappatura delle criticità, nonché l'individuazione e la diffusione della conoscenza delle soluzioni esistenti; formare una rete di imprese e associazioni finalizzata a ideare e sviluppare metodi e strumenti innovativi.
Presentazione a supporto dell'intervento di Elena Mocchio Responsabile Innovazione e Sviluppo UNI al webinar "IL MONITORAGGIO DELLA QUALITÀ DELL’ARIA NEGLI EDIFICI SCOLASTICI" del 25 novembre 2021
Fatturare Digitale - Come gestire in modo semplice la Fatturazione Elettronica.Fatturare Digitale
Relatore: Angela Tassone, Head Of Marketing & Communications in IWS Consulting
Durante il webinar sarà presentata una metodologia di lavoro, analisi e processi documentali che risponde alle attuali esigenze di gestione della Fatturazione Elettronica, attiva e passiva, con un proprio modulo e sistema automatizzato che include anche la conservazione digitale a norma.
Perché e come utilizzare un CMS per realizzare documentazione tecnica e di pr...KEA s.r.l.
I contenuti sono un capitale dell’azienda: vediamo come gestirli in modo ottimale e massimizzarne la resa, rispondendo in modo adeguato ai bisogni informativi dei destinatari e attivando nuovi servizi knowledge intensive per utenti interni, forza vendita, partner e rivenditori, installatori, utilizzatori, manutentori, ecc.
Guida pratica a come trasformare il contenuto da costo in risorsa a supporto della strategia aziendale.
Parcel XDoc consente di creare, gestire, raggruppare, tracciare la storia e la
distribuzione di documenti sia appartenenti a cicli documentali inerenti ai dossier
sia ad altri tipi di documenti. E’ possibile sottoporre contenuti controllati relativi
alle richieste di autorizzazione, come ad esempio quelle di nuovi farmaci (NDA)
agli enti normativi governativi preposti.
Il sistema gestisce il processo di presentazione delle richieste in conformità alle
normative, attraverso la specifica eCTD (Electronic Common Technical Document)
definita dall'ICH (International Conference on Harmonization) per lo scambio dei
dati tra aziende farmaceutiche ed enti normativi.
Edifici antisismici in Calcestruzzo Armato - 0 Obiettivi del capitolo 10 dell...Eugenio Agnello
Slide estratte da una presentazione del prof. Aurelio Ghersi, ordinario di ingegneria strutturale dell’Università di Catania, in occasione di un convegno “Edifici antisismici
in Calcestruzzo Armato, aspetti strutturali e geotecnici secondo le NTC 2008” che si è svolto nel Dicembre 2010 ad Acireale (CT).
NTC08 Alcuni punti chiave,
Principi e regole applicative,
Cambio di mentalità,
Principi come distinguerli,
La norma è perfetta?,
Elementi principali e secondari,
Gerarchia delle resistenze,
Elenco Elaborati,
Uso Codici di calcolo,
Analisi, verifiche e accettazione dei risultati,
Per il progettista,
Per il controllo del progetto,
Passi nella formulazione del giudizio,
Esame della struttura, modello ed analisi,
Previsione numerica del comportamento,
Esame dei risultati di calcolo,
Esame delle armature.
Slide a supporto dell'intervento di Alessandro Delvecchio - Ufficio Sviluppo Progetti UNI - al convegno "Tecnologie di realizzazione delle infrastrutture interrate a basso impatto ambientale" del 12 luglio 2017, organizzato da UNI, IATT e Unindustria
Lo stato dell' arte sulla documentazione dei progetti ICTMatteo Gentile
Ogni progetto informatico è sicuramente incompleto fino a quando non viene corredato da una documentazione esauriente. In un progetto informatico la documentazione è presente in tutte le fasi, dalla raccolta dei requisiti, passando per la documentazione di analisi e tecnica di implementazione, fino ad arrivare alla documentazione per l’utente finale.
Quali documenti è opportuno generare in un progetto ?
La documentazione di progetto va generata all’inizio o alla fine ?
Come fare a tenere sempre aggiornata la documentazione quando i requisiti o le implementazioni cambiano ?
Che standard usare per creare una buona documentazione di un progetto informatico ?
Recentemente c’è stata un'ampia diffusione delle metodologie Agili. E’ vero che non è prevista documentazione ?
Questo evento nasce per rispondere a queste domande e per mostrare attraverso un esempio pratico come introdurre la documentazione in un progetto che usa le metodologie Agili.
Modello economico del Cloud, Knowledge Intensive Business Servicesciii_inginf
Modello economico del Cloud. L’importanza dell’industria dei servizi, i KIBS (Knowledge Intensive Business Services).
Presentazione a cura dell'Ing. Bruno Lo Torto
Consigliere Centro Studi del Consiglio Nazionale Ingegneri
http://www.centrostudicni.it/
Similar to Documentazione tecnica e di prodotto: linee guida europee, leggi e norme; peculiarità del mercato USA (20)
Argo CCMS: come usare al meglio i file di configurazione per export in Word, ...KEA s.r.l.
Alla scoperta di uno strumento di Argo CCMS molto potente, che non sempre riceve la giusta attenzione.
Che cosa sono e a che cosa servono i file di configurazione?
I file di configurazione «registrano» tutte le impostazioni che eseguiamo durante una procedura di esportazione (es. in Word, Excel o XML).
Richiamando in seguito un file di configurazione ripetiamo la procedura di esportazione, applicando in modo automatico le impostazioni salvate... senza doverci pensare più!
Perché i file di configurazione sono utili?
I file di configurazione sono utili perché rendono la procedura di esportazione più veloce, certa e replicabile da ogni operatore.
Suggerimento! A questo scopo possiamo creare, per esempio, file di configurazione specifici per modello e versione, configurazione o matricola della macchina, per cliente, per lingua, per destinatario...
Dialogare con le macchine in linguaggio naturale... Finalmente! Ma ci voleva ...KEA s.r.l.
La storia del Natural Language Processing (NLP) parte negli anni Cinquanta del secolo scorso, ma fino a una decina di anni fa traduzioni automatiche, chatbot e assistenti vocali erano perlopiù fonte di ilarità o frustrazione, mentre ora - superato il magico stupore iniziale - dialogare in linguaggio naturale con una macchina è una comune esperienza quotidiana - che sia Google Translate, Alexa, ChatGPT o il chatbot di un sito, ecc. Come dire: “Finalmente le macchine hanno imparato a parlare la nostra lingua! Ci voleva tanto?”.
Sì, tantissimo: il linguaggio è un fenomeno molto complesso - perché intrinsecamente legato all’umana esperienza del mondo, a livello personale, relazionale, socio-culturale e storico -, un fenomeno che padroneggiamo con naturalezza, ma che abbiamo dovuto anzitutto capire come rendere “comprensibile” alle macchine. Padroneggiare il linguaggio non significa solo conoscere il significato delle parole e le regole sintattico grammaticali di una lingua, significa anche e soprattutto come generare senso mediante questi utensili linguistici. La questione centrale è come rendere “comprensibili” alle macchine i sistemi di produzione di senso in assenza del fatto che le macchine possano basarsi sul contesto esperienziale e relazionale che guida l’umana comprensione delle eccezioni, delle ambiguità, della semantica e della pragmatica della lingua.
Software per realizzare manuali e documentazione tecnica: Argo CCMS di KEAKEA s.r.l.
Da oltre 20 anni i nostri clienti scelgono di adottare Argo CCMS come software per gestire i contenuti tecnici e realizzare i manuali di istruzioni.
Molte aziende, prima di adottare Argo CCMS, usavano MS Word, Adobe InDesign o, più raramente, Adobe FrameMaker per realizzare a mano la documentazione tecnica.
Vediamo insieme il perché del cambio!
Quando un'azienda contatta KEA, le esigenze espresse più comunemente sono:
Gestire più volumi di documentazione
Risparmiare tempi e costi
Mitigare i rischi
Moltiplicare i tipi di output
Attuare l'approccio «digital first»
Rendere più fluida la collaborazione tra funzioni aziendali, con esperti esterni, distributori/rivenditori e utilizzatori finali
Accrescere la qualità
Gestire anche product data.
Perché e come usare i fumetti nella comunicazione tecnica e di prodottoKEA s.r.l.
I manuali di istruzioni di Antonio Carraro S.p.A. hanno una caratteristica che balza subito all’occhio: sono ricchi di vignette in cui è impossibile non immedesimarsi nei trattori antropomorfizzati e nei cartoon di agricoltori, tecnici e personaggi di contorno. Finiamo così per leggere con attenzione i testi che ci spiegano come dare una mano ai nostri beniamini e per imparare in modo dilettevole come usare e manutenere il nostro trattore
Ma perché i fumetti catturano la nostra attenzione? Perché ci immedesimiamo nei personaggi? Perché, rivivendo le loro storie, finiamo per imprimerle nella nostra memoria e apprendere in modo ludico anche informazioni utili?
I principi base dell’intelligenza artificiale spiegata ai non tecnici KEA s.r.l.
Invito alla lettura di Tom Taulli, Artificial Intelligence Basics: A Non-Technical Introduction, New York, Apress Media, 2019
Soprattutto a chi ha una formazione umanistica il libro di Tom Taulli spiega in modo chiaro i principi base dell’intelligenza artificiale: dalla preparazione dei dati al machine learning, dal deep learning alle reti neurali artificiali, dal natural language processing all’automazione robotica dei processi, dai robot/cobot fisici a come implementare un progetto di AI, fino ai cenni sul futuro dell’intelligenza artificiale
Come migliorare l’efficienza della formazione aziendaleKEA s.r.l.
Dal viaggio del cliente al viaggio del discente: spunti per migliorare l’efficienza della formazione aziendale
Invito alla lettura di Massimiliano Fiorelli, e-Learning Design: Progettare la formazione digitale con il mindset del Designer, 2021
Metaverso, ma non solo: come la vita digitale e l’economia digitale potrebber...KEA s.r.l.
Da quando, a fine ottobre 2021, Facebook Inc. ha assunto il nome di Meta Platforms Inc. il termine “metaverso” è sempre più ricorrente.
Che cos’è il metaverso? Esiste già? Qual è il suo rapporto con altre tecnologie - blockchain, token, NFT, criptovalute, smart contract e finanza decentralizzata - spesso citate insieme al metaverso?
Un percorso di lettura ci ha permesso di farci un’idea più precisa di una delle possibili evoluzioni del mondo digitale. Seguiteci!
Sono molte le aziende che, sulla documentazione stampata e/o sulle presenze online, indicano agli interlocutori il numero a cui essere contattate via WhatsApp.
Alcune aziende propongono sul sito anche applicazioni di live chat, mentre non sono molte quelle che promuovono l’uso di Telegram presso i propri contatti, come fanno - per esempio - Coop Viaggi ed Euronics sui volantini periodici.
Quali sono le caratteristiche che possono indurre un’azienda ad aggiungere Telegram al proprio mosaico di strumenti di comunicazione?
Social e valorizzazione della complessitàKEA s.r.l.
Invito alla lettura dello stimolante libro di Francesco Oggiano, SociAbility. Come i social stanno cambiando il nostro modo di informarci e fare attivismo, Milano, Piemme, 2022
***
Presupposto implicito del libro di Francesco Oggiano è che i social, diversamente dai motori di ricerca, hanno l’obiettivo di incrementare il nostro tempo di permanenza al loro interno.
Mentre i motori cercano di proporci i contenuti più rilevanti per la nostra ricerca, sapendo in questo modo di fidelizzarci, i social (con la parziale eccezione di comunità professionali come LinkedIn) si focalizzano sull’espressione delle emozioni, più che sulla comunicazione dei contenuti, per risvegliare la nostra attenzione, sollecitarci ad agire anzitutto digitalmente - valutando, condividendo o commentando - e indurci iterare il ciclo il più a lungo possibile.
Non va dimenticato che le azioni digitali sono monetizzabili da parte sia della piattaforma (per esempio in termini di profilazione dell’utenza e di vendita di pubblicità targetizzata), sia di singoli agenti (per esempio in termini di collaborazione con soggetti interessati a distribuire il loro messaggio alla rete di influenza dell’utente).
Argo CCMS: tutte le funzioni della finestra Gestione documentiKEA s.r.l.
Argo CCMS: tutte le funzioni della finestra Gestione documenti.
Come gestire elementi di classificazione, archivi (di contenuti comuni, di prodotti, ecc.) e documenti (manuali di istruzioni, cataloghi prodotto, schede, ecc.), revisioni.
Argo CCMS: come tradurre testi esportando e importando file MS Excel e XMLKEA s.r.l.
Argo CCMS: come tradurre testi usando le funzioni Esporta / Importa Office (formati supportati: MS Excel e XML)
Guida per il technical writer che usa Argo e per il traduttore che traduce sui file MS Excel o XML esportati da Argo
La SEO come conversazione fra le nostre presenze online, Google e chi cercaKEA s.r.l.
Tim Cameron-Kitchen ci aiuta a vedere la SEO come un dialogo costante fra noi, nel medium delle nostre presenze online, l’algoritmo di Google e gli utenti del motore di ricerca. Scopo della conversazione è far comprendere a Google le intenzioni della nostra comunicazione online e indurre il motore a posizionarci nel modo più coerente rispetto ai quesiti formulati dal singolo utente. Da questa prospettiva l’autore illustra in modo ampio, dettagliato e ricco di esempi come condurre questo dialogo, dal punto di vista dei contenuti delle nostre pagine web, del codice sorgente, della velocità di caricamento, della fruibilità mobile, delle attività sistemistiche, ecc.
Invito alla lettura di Tim Cameron-Kitchen, How To Get To The Top Of Google in 2022: The Plain English Guide to SEO, Exposure Ninja, 2020
L’importanza dei metadati nella comunicazione tecnica e di prodotto e come ge...KEA s.r.l.
I metadati sono importanti per automatizzare la selezione e l’aggregazione flessibile e dinamica di risorse rilevanti contestualmente, nonché per supportare funzioni di elaborazione dei contenuti da parte di agenti software e/o di interazione con i contenuti da parte di persone (es. funzioni di site search e filtri).
Il sistema di gestione dei contenuti Argo di KEA, impiegabile come sistema di component content management e di product information management, mette a disposizione del redattore tecnico numerosi strumenti per gestire i metadati.
Per maggiori informazioni http://www.keanet.it/argo-ccms-per-documentazione-tecnica-e-di-prodotto.html
Invito alla lettura di Riccardo Falcinelli: Figure. Come funzionano le immagi...KEA s.r.l.
Senza che ne siamo necessariamente consapevoli, le caratteristiche formali delle immagini guidano le nostre azioni, il nostro sguardo e il processo di elaborazione della “nostra” storia basata sulla percezione dei contenuti dell’immagine.
La scoperta dell’importanza del “come” (e non solo del “che cosa”) delle immagini è legato a un bel ricordo d’infanzia, quando Riccardo Falcinelli - sotto la guida della madre - esperisce, per approssimazioni successive, la distanza giusta a cui guardare le Ninfee di Monet…
Catalogo Natale Kasanova: edizioni 2020 e 2021 a confrontoKEA s.r.l.
Nel 2020 il Catalogo Natale di Kasanova - noto franchising con oltre 450 negozi specializzato nella vendita di casalinghi e articoli per la casa - mi colpì per il grado di integrazione esistente fra pubblicazione stampata, spot televisivi ed e-shop dell’azienda.
Conservai l’edizione 2020 del catalogo con l’intenzione di raffrontarla all’edizione di quest’anno, disponibile al seguente URL:
https://www.kasanova.com/it/volantino-natale-kasanova/
Scoprire le differenze fra le due edizioni del catalogo natalizio di Kasanova ci può dare indicazioni utili su come l’azienda ha reagito al feedback dei clienti e all’evoluzione della comunicazione.
Argo CMS – Come riusare manualmente contenuti all’interno di documenti distintiKEA s.r.l.
Argo CMS - Come riusare manualmente contenuti all’interno di documenti distinti. Riuso come link, mantenendo il collegamento fra documento di partenza e di destinazione oppure copia del contenuto da documento di partenza a documento di destinazione
Argo CMS – Come riusare manualmente contenuti all’interno di documenti distinti
Documentazione tecnica e di prodotto: linee guida europee, leggi e norme; peculiarità del mercato USA
1. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
Documentazione tecnica e di prodotto: panoramica su linee
guida europee, leggi e norme, nonché sulle peculiarità del
mercato USA
Report sul libro di Lars Kothes, Grundlagen der technischen Dokumentation, SpringerVerlag, Berlin, Heidelberg, 2011
Linee guida europee, leggi nazionali, norme
La prima parte del libero di Kothes è dedicata a un panoramica interessante sul rapporto fra linee guida
europee, leggi nazionali e standard nel settore della documentazione tecnica.
Linee guide della Commissione Europea
Seguendo il cosiddetto New Approach, le nuove linee guida della Commissione Europea non contengono
più indicazioni specifiche, ma prescrizioni sui requisiti fondamentali che il prodotto e la sua documentazione
devono avere dal punto di vista della sicurezza.
Le istruzioni nella lingua dell’utilizzatore sono parte costitutiva di ogni prodotto sicuro.
Leggi nazionali
Le leggi recepiscono a livello nazionale le linee guide emanate dalla Commissione Europea.
Norme
Contrariamente a quanto avviene per linee guida e leggi, l’adesione alle norme è volontaria.
Le norme tendono a fornire indicazioni concrete su come mettere in atto i dettami di linee guida e leggi.
Esistono norme armonizzate con le linee guida / le leggi e norme non armonizzate.
L’adesione a norme armonizzate non dà la certezza, ma la presunzione della conformità del prodotto e
della documentazione ai dettami di linee guida e leggi.
Il sito www.newapproach.org, curato da Commissione Europea, EFTA, CEN, CENELEC ed ETSI, fornisce
un elenco aggiornato delle norme armonizzate.
Panoramica su norme e altre risorse utili
Kothes fornisce una panoramica sulle principali norme e su altre risorse utili nell’ambito della
documentazione tecnica e di prodotto.
Il sito http://www.beuth.de/en/ rappresenta una risorsa utile per cercare, approfondire e acquistare norme e
altre risorse.
Qui di seguito un estratto delle norme e delle risorse citate da Kothes:
•
DIN EN 62079:
•
Norma non armonizzata
1
Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle
peculiarità del mercato USA – Febbraio 2014
2. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
•
DIN EN ISO 12100-2:
•
•
•
Norma armonizzata di tipo A. E’ considerata la trasposizione normativa della Direttiva Macchine. Ai
fini della documentazione tecnica e di prodotto è rilevante in particolare il Capitolo 6
E’ l’unica norma che si occupa della documentazione in formato elettronico. Kothes sottolinea che –
sebbene linee guida, leggi e norme non impongano la fornitura della documentazione in formato
cartaceo – attualmente la carta è l’unico medium che permette all’utente di usufruire della
documentazione senza dispositivi aggiuntivi, come previsto dalla legislazione. In attesa di
un’evoluzione tecnologica comunque probabile, il consiglio di Kothes è di fornire almeno una copia
cartacea della documentazione, considerando i formati elettronici come supporti aggiuntivi
DIN EN ISO 14121-1:
•
•
ANSI B11.19-2003 R2009 e ANSI B11.TR3-2000:
•
•
Standard USA dedicato in particolare all’analisi dei rischi per il mercato statunitense
ISO Guide 37:
•
•
Norma armonizzata secondo la Direttiva Macchine e dedicata in particolare all’analisi dei rischi
Standard internazionale dedicato alla redazione di documentazione per prodotti destinati al mercato
consumer
DIN 146:2006-01:
•
Technical report dedicato alla redazione di documentazione per impianti
•
A partire dalla documentazione dei fornitori, il report suggerisce di realizzare così il manuale
d’istruzioni dell’impianto:
•
•
Inserire link di approfondimento ai documenti dei fornitori
•
•
Estrarre dalla documentazione dei fornitori le informazioni di base relative a dispositivi di
sicurezza, uso, manutenzione e troubleshooting
Rendere accessibili i documenti dei fornitori attraverso indici multidimensionali, per esempio:
indice per produttore, per nome del prodotto, per gruppi / componenti, per flusso di lavoro, ecc.
Risorse dedicate a segnaletica e simboli grafici:
•
DIN 4844-1 e DIN 4844-2
•
Standard dedicato alla segnaletica nei luoghi pubblici e di lavoro
•
Kothes consiglia di inserire nel manuale la spiegazione e il piano di dislocazione della segnaletica
a bordo macchina, in modo tale da agevolarne non solo la comprensione, ma anche la
sostituzione in caso di distacco
•
ISO 3864-1
•
DIN ISO 3864-2 e DIN ISO 3864-3
•
DIN ISO 7000 e 7001
•
ANSI Z535.1 ad ANSI Z535.4
•
•
Standard USA per la redazione di Danger, Warning, Caution e Notice
VDI 4500 Fogli da 1 a 4:
2
Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle
peculiarità del mercato USA – Febbraio 2014
3. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
•
•
Guida alla redazione della documentazione tecnica e di prodotto realizzata dall'Associazione degli
Ingegneri Tedeschi (VDI - Verein Deutscher Ingenieure)
DIN EN 15038:
•
Norma dedicata alla gestione e realizzazione di traduzioni, con la possibilità – per i traduttori – di
certificarsi.
Particolarità del mercato USA
Negli Stati Uniti la responsabilità civile per i prodotti non è regolamentata a livello nazionale, ma federale,
cioè a livello di singolo stato.
Secondo la tradizione giurisprudenziale americana, legislazione, che può quindi differire fra stato e stato,
emerge dalle sentenze pregresse, è cioè essenzialmente una “case law”.
Le organizzazioni USA di cui considerare gli standard sono principalmente tre, anche se l’adesione non dà
luogo a presunzione di conformità:
•
OSHA (Occupational Safety and Health Administration)
•
ANSI (American National Standards Institute)
•
UL (Underwriters Laboratories).
Nella redazione di documentazione per il mercato statunitense Kothes consiglia di tenere in considerazione,
fra gli altri, questi aspetti:
•
Negli USA il background tecnico medio è inferiore a quello europeo e tedesco in particolare
•
E’ quindi necessario:
•
Realizzare istruzioni passo passo, corredate da illustrazioni chiare
•
Prevedere strumenti che agevolino al massimo il reperimento delle informazioni
•
Fornire la documentazione non solo in inglese americano, ma eventualmente anche in spagnolo
messicano, in base al target di destinazione
•
Curare in modo particolare la correttezza della traduzione e l’omogeneità della terminologia. Il sistema
giuridico statunitense rubrica come “negligenze” gli errori di traduzione e le incomprensioni, ascrivendole
a responsabilità del produttore
•
Eseguire l’analisi dei rischi secondo lo standard ANSI B11.19-2003 R2009 e ANSI B11.TR3-2000
•
Aggiungere all’inizio del manuale i seguenti capitoli:
•
Supplemental Directives
•
•
Introduzione
•
•
Va pubblicato prima del sommario e contiene testi generali sulla sicurezza secondo lo standard
ANSI Z535.6
Illustra con foto e testi gruppi e componenti principali del prodotto, descrivendone finalità e
funzioni di base
Spostare in fondo al manuale, prima del glossario, il capitolo dedicato all’esposizione dei dati tecnici del
prodotto.
3
Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle
peculiarità del mercato USA – Febbraio 2014
4. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
Gestione modularizzata dei contenuti
Fra i numerosi suggerimenti forniti da Kothes in tema di redazione e pubblicazione, vi è anche quello di
gestire in modo modulare i contenuti, per migliorare l’efficienza del flusso di redazione, revisione, traduzione
e pubblicazione.
Kothes sottolinea alcune specificità della gestione modularizzata dei contenuti:
•
Metadati: necessari per identificare, ricercare e riusare i contenuti
•
Stato di avanzamento del contenuto: l’authoring tool o il sistema di content management (CMS)
dovrebbe permettere di gestire lo stato di avanzamento del contenuto (es. Nuovo, In fase di redazione,
In fase di verifica, Approvato) ed eventualmente di bloccare contenuti approvati
•
Revisione: secondo Kothes, l’authoring tool o il sistema di content management (CMS) non dovrebbero
aggiornare in automatico i moduli riusati, ma congelarne la revisione alla consegna del documento. Il
sistema dovrebbe però segnalare la presenza di eventuali aggiornamenti, permettendo al redattore di
adottare o meno la versione rivista
•
Riferimenti incrociati: in particolare in caso di pubblicazioni parziali (per esempio per singoli
destinatari), l’authoring tool o il sistema di content management (CMS) dovrebbero verificare e segnalare
la presenza di broken link fra i riferimenti incrociati a capitoli / paragrafi e figure
•
Riuso: l’authoring tool o il sistema di content management (CMS) dovrebbero permettere al redattore di
verificare in quali documenti un modulo è riusato.
Autore: Petra Dal Santo (dalsanto@keanet.it)
www.keanet.it
http://blog.keanet.it/
4
Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle
peculiarità del mercato USA – Febbraio 2014