La documentazione industriale, anche nella sua produzione, non segue le stesse regole di altri tipi di documentazione tecnica.

Se per i prodotti software si possono ad esempio valutare i benefici di un approccio inverso all’help authoring, parlando di documentazione industriale un tale approccio non ha alcun significato: non è possibile, infatti, avere alcuna documentazione “post release”, in quanto la documentazione è necessaria per poter immettere un prodotto sul mercato.

Dal 2009 infatti è diventato vincolante, per produttori e distributori, rispettare la nuova Direttiva Macchine che introduce diversi concetti, tra cui quello delle “quasi macchine”.

Le “quasi macchine” sono parti destinate ad essere incorporate od assemblate ad altre perché da sole non sono in grado di svolgere una funzione.

Per questo tipo di prodotti, secondo la direttiva, non esiste più l’obbligo della marcatura CE di conformità, ma va redatta una Dichiarazione di Incorporazione.

Chi costruisce quasi-macchine, è tenuto a fornirle dotate di questa dichiarazione e delle istruzioni per l’assemblaggio con le altre parti.

Se tale documentazione viene a mancare o non è conforme alla normativa, non è consentita la fornitura della macchina.

Quindi non solo per macchinari completi, ma anche per parti di macchinari la documentazione dovrà accompagnare il prodotto, dal che consegue che il processo di produzione della documentazione deve andare di pari passo con quello del prodotto, pena l’impossibilità di commercializzarlo.

La funzione si avvale della collaborazione di risorse interne ed esterne specializzate.

La proposta è indirizzata a candidati con titolo di studio ad indirizzo tecnico, ed esperienza almeno quinquennale nel technical editing maturata in aziende e società di consulenza specializzate, dotati di solide competenze tecniche estese, quanto più possibile, alle tematiche elettrico-elettroniche e meccaniche e all’utilizzo dei più diffusi tools informatici di editing (Adobe Illustrator preferito).
L’utilizzo professionale della lingua inglese e la disponibilità a brevi trasferte completano il profilo del candidato.

La sede di lavoro è tra Modena e Bologna

Ricerca in corso al 17 aprile 2012

RE.S. STUDIUM sas
Autorizzazione Ministero del Lavoro 643/2007
via Zucchi 21 41100 Modena
tel. 059.820.728 – fax 059.827.921
www.resstudium.it
info@resstudium.it
skype: resstudium

I candidati i cui dati saranno trattati e conservati esclusivamente per attività inerenti questa o future selezioni godono dei diritti ex art. Dlgs 276/2003

Alcuni technical writers ritengono che il prezzo vada calcolato “a parola”. Se da un lato questa valutazione può essere di più facile comprensione per il cliente, dall’altro finisce per snaturare il lavoro in sé che non è certamente dato solo dalla scrittura.

Ma non si tratta solo di svalutazione del proprio lavoro: anche se un freelance non deve sostenere le stesse spese di un’azienda, certamente nella stesura di un preventivo le spese vanno considerate e, per piccoli lavori, diventa difficile giustificare costi a parola altissimi solo perché, per stendere un piccolo manuale, sono state necessarie 4 visite al cliente che ha cambiato idea in corso d’opera. E magari l’ha fatto proprio per ridurre le dimensioni del manuale e quindi i costi.
Aspetti che occorre sempre far valutare al cliente, sono invece i minori costi di traduzione e di stampa che un manuale, esaustivo ma conciso, comporterà per la sua azienda.

Altri importanti aspetti di cui una valutazione “a parola” non tiene conto sono quelli dell’impaginazione e della eventuale scelta di tabelle o disegni da inserire all’interno di un manuale, della stesura di un indice o della struttura degli hyperlink contenuti all’interno di un help.

Quello che occorre valutare per stilare un preventivo corretto, è il tempo impiegato per fare il lavoro. Anche il tempo è una quantità comprensibile per il cliente e, a differenza di un costo a parola, se esistono problemi di budget limitato potremo sempre far presente al cliente che possiamo “andargli incontro”. Non facendo un lavoro frettoloso, ovviamente, ma scontandogli alcune ore.

Il nuovo standard DITA (Darwin Information Typing Architecture), un formato aperto approvato nel 2005 dall’OASIS (Organisation for the Advancement of Structured Information Standards), nasce proprio per organizzare sistemi informativi complessi e distribuiti senza perdere informazioni né trasportarne di inutili.

A tale scopo, il modello DITA introduce l’idea dell’ereditarietà nella gestione delle informazioni: ad ogni dato vengono associati gli eventuali sviluppi che possono da esso derivare mentre, a monte, il dato è collegato ai suoi “parents”. Alla radice di questo albero si trova l’archetipo dell’unità informativa, una sorta di “idea base” del dato stesso.

Strutturando i dati in questo modo, il modello DITA permette di integrare dati già esistenti in modelli informativi spesso molto diversi, che fanno capo ad una azienda di dimensione internazionale, senza dover ricorrere a dispendiose e a volte forzate conversioni dei dati stessi né a ristrutturazioni totali per integrare i diversi sistemi informativi.

Dei singoli dati, a seconda della situazione o della competenza specifica di una unità operativa, potranno essere richiamate sia la versione di base, che le versioni discendenti e specializzate. Di un unico dato, infatti, potranno coesistere diverse versioni specializzate, per utilizzi in ambito diverso: la stessa informazione di base sarà trattata in un modo dal marketing ed in un altro dal settore tecnico, che potranno modificarne la versione specializzata di loro competenza, senza toccare quella che è la versione minima di base, la radice. La scalabilità di un simile sistema di aggregazione dati è, ovviamente, virtualmente infinita.

Una grande rivoluzione è stata la nascita dalle piattaforme di scrittura collaborative, che hanno in Wikipedia l’esempio più conosciuto.

Scrivere documentazione tramite una piattaforma web-based, ha senza dubbio molti vantaggi. Il primo è certamente l’immediatezza con cui gli aggiornamenti della documentazione vengono resi disponibili all’utente.

Pensiamo ad una grande azienda di sviluppo software. Aggiornamenti nella documentazione, aggiornamenti sui bugs e le release, correzione degli errori nella documentazione: l’aggiornamento è immediato. Ma non solo: le piattaforme wiki permettono la gestione di accessi di vario livello. Potremmo quindi avere una documentazione online pubblica ed una disponibile solo per gli utenti registrati. Anche i permessi di scrittura potranno essere di diverso livello: l’utente registrato potrà avere la possibilità di commentare le diverse parti della documentazione, segnalare un errore o dire, in caso di help online, se l’informazione gli è stata utile per risolvere un problema.

Ma wiki non è solo questo: alla stessa documentazione, infatti, avranno accesso gli sviluppatori, i technical writer che si occupano dell’help, gli addetti al marketing che si occupano della stesura di brochure informative. La documentazione diventa più facile e veloce da consultare perché si addotta un layout comune, vengono aggiunti link “a portata di click” anziché note a pié pagina che rimandano a riferimenti non sempre facilmente raggiungibili.

Pensiamo ad un grosso sistema di sviluppo: mantenere aggiornate le note di riferimento di centinaia di file pdf tra loro collegati è un lavoro a dir poco impossibile e l’utente spesso finisce col passare ore a cercare, non la risposta alla sua domanda, ma il pdf in cui tale risposta è contenuta.

Ovviamente la documentazione così strutturata non può essere comodamente riportata in un file pdf da consultare offline. Anche se quasi tutti i wiki permettono l’esportazione in questo formato, infatti, non va dimenticato che la lettura di un file sequenziale segue regole diverse dalla lettura all’interno di un browser ed un file singolo deve essere strutturato in modo adeguato.

Occorre mettersi nei panni del fruitore, cercando di immaginarne i possibili ragionamenti per guidarlo in modo da trovare le informazioni richieste con il minimo sforzo possibile. Questo processo richiede sia una competenza tecnica sufficientemente approfondita del prodotto o dello strumento che si sta presentando, sia una conoscenza di base delle modalità di ragionamento dell’essere umano.

Fondamentale è quindi il disegno dei prerequisiti dell’utilizzatore. Chi acquista una lavatrice deve poter imparare velocemente a selezionare il tipo di lavaggio adeguato per ogni occasione, non ha interesse a sapere quanta potenza sviluppa il motore durante una centrifuga a pieno carico e non è compito del manuale spiegare che esiste il lavaggio a secco. Senza dare per scontata alcuna conoscenza, il manuale dovrà invece riportare una legenda delle varie indicazioni di lavaggio che vengono solitamente riportate sulle etichette.

Un collegamento, quest’ultimo, che potremmo chiamare di interconnessione, una dimostrazione che i link non esistono solo sul web e che il modo di strutturare ed interconnettere le informazioni è oggi di fondamentale importanza.

Fondamentali sono quindi la comprensione tecnica di ciò che si andrà a spiegare e la definizione delle necessità dell’utente.
Il manuale d’uso di una apparecchiatura, ad esempio, richiede la conoscenza di tutte le opzioni di utilizzo, di tutti i problemi che possono presentarsi e delle possibili eventuali soluzioni.

Per la stessa apparecchiatura, il manuale di installazione offirà contenuti diversi che dovranno essere chiari, comprensibili ed esaustivi per l’installatore. Fino a pochi anni fa, la stesura dei manuali d’uso era affidata a personale interno alle aziende di produzione. Se da un lato questo comportava una maggiore conoscenza delle apparecchiature o dei macchinari, dall’altro la valutazione della validità del manuale, anch’esso fatta internamente all’azienda, spesso perdeva di vista l’utente finale, sommergendolo di informazioni a volte inutili, a volte poco comprensibili.

Con la figura, solitamente esterna all’azienda, del Technical Writer, il centro della scrittura di manualistica e documentazione è diventato l’utente di destinazione. La figura del Technical Writer rende sempre meno necessario il “Manuale di Istruzioni per Leggere il Manuale” che molti di noi avrebbero in qualche occasione desiderato.

L’approccio inverso alla documentazione, prevede invece che la maggior parte del lavoro di scrittura dell’help venga fatta dopo il rilascio del prodotto. Questo per due motivi: il primo è che difficilmente si possono immaginare tutte le possibili domande di un utente, il secondo è che, lavorando a stretto contatto con gli sviluppatori e seguendo passo passo la crescita di un prodotto, si finisce per assumere una competenza che rischia di far dare per scontate molte risposte.

Un terzo valido motivo per utilizzare un approccio inverso alla stesura della documentazione, è che in questo modo la documentazione non cresce seguendo il prodotto, ma seguendo i problemi e le difficoltà riscontrate dagli utenti. Man mano che gli utenti diventano più esperti ed utilizzano il prodotto in maniera più complessa, anche alla documentazione verranno aggiunti approfondimenti più complessi e non si incorrerà nell’errore di trattare tutti gli argomenti allo stesso modo.
In questo tipo di approccio, sono ovviamente fondamentali i feedback da parte degli utenti, che diventano il punto di riferimento del technical writer. Come dovrebbe essere.

Dropbox è uno tra i servizi di file-hosting più di successo, che permette ai suoi utenti di salvare file su un computer o cellulare connesso al web, per poi reperirli automaticamente su qualunque altro nostro dispositivo. Non si tratta però di un servizio gratuito. I risibili 2 Gb previsti nella versione gratuita sono appena sufficienti a capirne le logiche. Per poter utilizzare Dropbox al massimo delle potenzialità, invece, è necessario un abbonamento da 9,90 o 19,90 euro per gestire un account da 50 o 100 Gb. Basta installare una semplice app per Android per ottenere altri 23 Gb di capacità per il proprio account.

Chi possiede un dispositivo con sistema operativo Android, però, può avvalersi di un compromesso. Basta installare un’applicazione dedicata tramite una semplice procedura per ottenere per due anni 23 ulteriori Gb di capacità di hosting per il proprio account, del tutto gratuitamente.

Ecco come fare:

1. Per prima cosa, è necessario disinstallare l’applicazione classica di Dropbox, qualora installata su Android. Basta accedere alla gestione delle applicazione all’interno del menù Impostazioni e dare il comando per disintallare la app dal dispositivo

2. Adesso è possibile installare l’applicazione Dropbox+23GB APK (dopo aver consentito l’accesso a applicazioni sconosciute nelle impostazioni di sicurezza).

3. Aprire l’applicazione e fare il log in, come al solito.

4. Infine, attendere l’email di conferma da parte di Dropbox.

Al termine della procedura, l’email vi confermerà la vostra incrementata capacità di hosting fino a 25 Gb, valida per due anni.

Ecco perchè, spulciando tra i vari gadget non propriamente funzionali ma indiscutibilmente estetici, mi sono imbattuta in questa collana che, onestamente, indosserei anche e soprattutto nelle occasioni più eleganti. iNecklace è un ciondolo in alluminio con al centro un sottile LED pulsante. Realizzato per le donne che amano la tecnologia e cercano gioielli di design e all’avanguardia.

Questo gioiello è prodotto da Adafruit, la compagnia che produce creazioni di elettronica divertenti da indossare e dall’aspetto elegante.

Il ciondolo è in alluminio, e contiene un circuito con pulsanti LED e batteria; è appeso su una catena lunga in argento, e viene messo in vendita in una scatola di velluto nero, proprio come se fosse un gioiello prezioso. Packaging ovviamente di sicuro effetto, perchè normalmente contiene qualcosa che si misura in carati (maschietti, prendete nota!)

iNecklace è completamente open source: il codice sorgente, i file del circuito, schemi e file CAD sono pubblicati su GitHub. iNecklace può essere riprogrammato per qualsiasi motivo si desideri: basta inserire la batteria , avvitare il supporto e iNecklace pulserà dolcemente, al ritmo del cuore, per un massimo di 72 ore. Le batterie sono incluse.

Ammetto che pecchi un tantino di funzionalità, ma è sicuramente indicato per quelle donne, e sono molte, che si lasciano incantare dalla tecnologia e che odiano luccichii e bagliori di perline e strass (che trovo francamente un po’ eccessivi). Indicato per chi ha fatto della tecnologia una scelta di vita, e lo vuole mostrare in ogni dettaglio.