Mi sono imbattuto per caso in un "meta-motore di ricerca", CC Search, che consente di recuperare immagini, video e scritti coperti dalla licenza Creative Commons.
Usando CC Search è possibile individuare materiale utilizzabile "liberamente" all'interno delle vostre opere, nel senso che dovrete rispettare solo i dettami della licenza Creative Commons.
CC Search è un meta-motore nel senso che effettua ricerche di materiale CC-based in altri "contenitori", come You Tube o Google Images. Provatelo.
Leggi questo articolo...
martedì 21 febbraio 2012
domenica 19 febbraio 2012
Saper scrivere... il Glossario: terza parte
Eccoci al terzo post, dopo i due precedenti:
Oggi ci occupiamo del design del Glossario.
Ecco un primo esempio, tratto dal manuale del mio BlackBerry Curve:
Oggi ci occupiamo del design del Glossario.
Ecco un primo esempio, tratto dal manuale del mio BlackBerry Curve:
Ed ecco il secondo esempio, relativo ad uno standard della RSA, il PKCS11:
Come vedete, emergono 2 sole regole basilari:
- i termini vengono elencati in ordine alfabetico
- la struttura è solo una lista di coppie TERMINE - DEFINIZIONE
Un'altra opzione riguarda la possibilità di inserire, nella descrizione di un termine, un link ad un altro termine del Glossario. Questa soluzione può essere utile se il Glossario è particolarmente ricco e con numerosi elementi, ma perde efficacia se il manuale viene consultato in formato cartaceo e non in formato digitale.
Se non volete inserire un link ma volete comunque riferirvi ad altri termini presenti, potete scegliere altre opzioni: vedi - vedi anche - confronta.
TERMINE X: DESCRIZIONE X. Vedi TERMINE Y.
In questa situazione, all'interno della DESCRIZIONE X viene citato il TERMINE Y; in coda, si può utilizzare Vedi TERMINE Y per guidare il lettore al significato di Y che serve a definire X.
TERMINE X: DESCRIZIONE X. Vedi anche TERMINE Y.
Questa situazione significa che la DESCRIZIONE X è chiusa ma può essere eventualmente arricchita da ulteriori informazioni proposte altrove.
TERMINE X: DESCRIZIONE X. Confronta TERMINE Y.
Questa situazione significa che la DESCRIZIONE X può non essere esaustiva o va valutata in base al contesto e viene arricchita da informazioni complementari contenute in Y.
A questo punto siete in grado di scrivere il vostro Glossario ed avete tutte le informazioni necessarie per farlo.
Ma un Glossario è un oggetto "vivo" che può evolvere nel tempo per diversi motivi. Al prossimo ed ultimo post per chiudere l'argomeno.
Leggi questo articolo...
Se non volete inserire un link ma volete comunque riferirvi ad altri termini presenti, potete scegliere altre opzioni: vedi - vedi anche - confronta.
TERMINE X: DESCRIZIONE X. Vedi TERMINE Y.
In questa situazione, all'interno della DESCRIZIONE X viene citato il TERMINE Y; in coda, si può utilizzare Vedi TERMINE Y per guidare il lettore al significato di Y che serve a definire X.
TERMINE X: DESCRIZIONE X. Vedi anche TERMINE Y.
Questa situazione significa che la DESCRIZIONE X è chiusa ma può essere eventualmente arricchita da ulteriori informazioni proposte altrove.
TERMINE X: DESCRIZIONE X. Confronta TERMINE Y.
Questa situazione significa che la DESCRIZIONE X può non essere esaustiva o va valutata in base al contesto e viene arricchita da informazioni complementari contenute in Y.
A questo punto siete in grado di scrivere il vostro Glossario ed avete tutte le informazioni necessarie per farlo.
Ma un Glossario è un oggetto "vivo" che può evolvere nel tempo per diversi motivi. Al prossimo ed ultimo post per chiudere l'argomeno.
mercoledì 8 febbraio 2012
Scrivere un CV efficace e con stile
In passato ho scritto diversi post relativi a quei documenti utili per misurarsi con il mondo del lavoro, ed in particolare:
E' difficile essere innovativi su argomenti come questi, molto presenti in rete, oserei dire inflazionati.
Da parte mia ho tentato, sperando di riuscirci, di dare qualche indicazione utile ed originale, non improntata al modello scontato e facile della "cut&paste economy".
E' in quest'ottica che vi segnalo una delle risorse più interessanti ed originali in cui mi sono imbattuto ultimamente, il sito di Paolo Bruno.
Paolo si autodefinisce "IT Architect per professione, Social addicted per natura, job consultant e opinionista per diletto".
Da quello che ho letto, ha sicuramente talento per la comunicazione.
In particolare, vi segnalo un post su come realizzare un CV Europeo improntato a soluzioni stilisticamente interessanti, che penso possa essere utile per migliorare il proprio CV.
Lo stile del post è chiaro, modello "Tutorial", scorrevole e completo.
Nel suo sito troverete molte altre cose, scritte in modo brioso ed efficace. Anche l'impostazione del sito è molto accattivante. Vi consiglio di "saccheggiarlo", potrete ricavarne molti utili spunti, anche se non siete professionisti dell'IT. Buona lettura. Leggi questo articolo...
E' difficile essere innovativi su argomenti come questi, molto presenti in rete, oserei dire inflazionati.
Da parte mia ho tentato, sperando di riuscirci, di dare qualche indicazione utile ed originale, non improntata al modello scontato e facile della "cut&paste economy".
E' in quest'ottica che vi segnalo una delle risorse più interessanti ed originali in cui mi sono imbattuto ultimamente, il sito di Paolo Bruno.
Paolo si autodefinisce "IT Architect per professione, Social addicted per natura, job consultant e opinionista per diletto".
Da quello che ho letto, ha sicuramente talento per la comunicazione.
In particolare, vi segnalo un post su come realizzare un CV Europeo improntato a soluzioni stilisticamente interessanti, che penso possa essere utile per migliorare il proprio CV.
Lo stile del post è chiaro, modello "Tutorial", scorrevole e completo.
Nel suo sito troverete molte altre cose, scritte in modo brioso ed efficace. Anche l'impostazione del sito è molto accattivante. Vi consiglio di "saccheggiarlo", potrete ricavarne molti utili spunti, anche se non siete professionisti dell'IT. Buona lettura. Leggi questo articolo...
martedì 7 febbraio 2012
Saper scrivere... il Glossario: seconda parte
Nel post precedente abbiamo individuato 4 criteri di base per costruire un Glossario:
Oggi ci concentriamo sul secondo punto.
Immaginiamo di aver individuato un primo ed ampio insieme di termini che secondo noi andrebbero inseriti nel Glossario. Siamo certi di doverli includere tutti?
Forse è meglio fare qualche esempio.
Se sto scrivendo un manuale per installare un pannello fotovoltaico e faccio riferimento ad una normativa tecnica internazionale, forse è il caso di classificarla nel Glossario. Ma se consideriamo un concetto che viene ben sviluppato all'interno del documento, si può certamente evitare di includerlo, perché è integralmente definito e sviluppato al suo interno, quindi non è un concetto "esterno" che deve essere "spiegato" nel Glossario per renderlo intellegibile.
Questa regola, appena illustrata, tende a distinguere tra un set di concetti "esterni" ed un set di concetti "sviluppati internamente" al documento.
I principali concetti "esterni" sono ottimi candidati ad entrare nel Glossario.
In alcuni rari casi, anche i concetti "sviluppati internamente", se veramente fondamentali, possono entrare nel Glossario per fornire al lettore una specie di guida veloce ai concetti chiave che poi troverà nel corpo del manuale.
Altro aspetto riguarda invece i concetti che possono essere collegati a definizioni non univoche.
Se sto scrivendo il Manuale Utente di un software crittografico, quando descrivo l'operazione di Cifratura, mi trovo a dover fare una scelta. Ovviamente non ha senso descrivere nel Glossario i dettagli dell'operazione, perchè tali dettagli sono ampiamente indicati nel manuale. Quindi fornire una definizione "operativa" non mi interessa.
Ma forse dare una definizione "generale", di alto livello, del concetto di Cifratura di un file può essere assolutamente consigliabile, specie se il lettore ipotetico del nostro manuale non è necessariamente un esperto di crittografia.
In questo esempio, abbiamo un caso molto frequente: dato un concetto, ad esso potrebbe essere associata più di una definizione, in base al contesto e/o al lettore-target.
Riassumendo, teniamo sempre presenti 2 criteri:
Leggi questo articolo...
- Focalizzare l'audience del documento
- Scegliere i termini da inserire
- Progettare un design essenziale
- Gestirne l'evoluzione nel tempo
Oggi ci concentriamo sul secondo punto.
SCEGLIERE I TERMINI DA INSERIRE
Immaginiamo di aver individuato un primo ed ampio insieme di termini che secondo noi andrebbero inseriti nel Glossario. Siamo certi di doverli includere tutti?
Forse è meglio fare qualche esempio.
Se sto scrivendo un manuale per installare un pannello fotovoltaico e faccio riferimento ad una normativa tecnica internazionale, forse è il caso di classificarla nel Glossario. Ma se consideriamo un concetto che viene ben sviluppato all'interno del documento, si può certamente evitare di includerlo, perché è integralmente definito e sviluppato al suo interno, quindi non è un concetto "esterno" che deve essere "spiegato" nel Glossario per renderlo intellegibile.
Questa regola, appena illustrata, tende a distinguere tra un set di concetti "esterni" ed un set di concetti "sviluppati internamente" al documento.
I principali concetti "esterni" sono ottimi candidati ad entrare nel Glossario.
In alcuni rari casi, anche i concetti "sviluppati internamente", se veramente fondamentali, possono entrare nel Glossario per fornire al lettore una specie di guida veloce ai concetti chiave che poi troverà nel corpo del manuale.
Altro aspetto riguarda invece i concetti che possono essere collegati a definizioni non univoche.
Se sto scrivendo il Manuale Utente di un software crittografico, quando descrivo l'operazione di Cifratura, mi trovo a dover fare una scelta. Ovviamente non ha senso descrivere nel Glossario i dettagli dell'operazione, perchè tali dettagli sono ampiamente indicati nel manuale. Quindi fornire una definizione "operativa" non mi interessa.
Ma forse dare una definizione "generale", di alto livello, del concetto di Cifratura di un file può essere assolutamente consigliabile, specie se il lettore ipotetico del nostro manuale non è necessariamente un esperto di crittografia.
In questo esempio, abbiamo un caso molto frequente: dato un concetto, ad esso potrebbe essere associata più di una definizione, in base al contesto e/o al lettore-target.
Riassumendo, teniamo sempre presenti 2 criteri:
- Distinguere tra concetti "esterni" e "sviluppati internamente" al documento: i primi spesso andranno inseriti nel Glossario, i secondi solo in rari casi.
- Dato un concetto, potrebbe essere associato a più di una definizione: nel dubbio, inserite nel Glossario la definizione "più utile" al lettore per aiutarlo nella comprensione del documento.
Leggi questo articolo...
domenica 5 febbraio 2012
Saper scrivere... il Glossario: prima parte
In un documento tecnico spesso vengono utilizzati termini ed acronimi molto specialistici.
Ma colui che dovrà leggere il documento, sarà in grado di interpretare correttamente tali contenuti?
La risposta più facile e "pigra" è SI, ed è la risposta che ci "scarica" dalla responsabilità di un ulteriore sforzo per migliorare la comprensione del documento.
In realtà, è SEMPRE buona norma corredare i nostri documenti di un Glossario, cioè di una raccolta specifica e circoscritta dei termini specialistici presenti nel documento, accompagnati dalle relative spiegazioni.
- Focalizzare l'audience del documento
- Scegliere i termini da inserire
- Progettare un design essenziale
- Gestirne l'evoluzione nel tempo
Avendo chiari in mente questi 4 punti cardinali, siamo già a buon punto.
FOCALIZZARE L'AUDIENCE DEL DOCUMENTO
Come sempre, scriviamo per qualcuno. Una delle regole auree della scrittura tecnica ci impone di immaginare chi leggerà il nostro documento.
E' un principiante? Allora dovremo inserire nel Glossario anche le voci che non metteremmo se invece ci rivolgiamo ad un utente esperto. Se il mio manuale parla del funzionamento di un software e lo legge un Ingegnere Informatico, forse non devo spiegare cosa sia una GUI (Graphic User Interface).
Altrimenti, è preferibile inserire tale acronimo nel Glossario.
Idem per altri acronimi, quali CPU o RAM o SOAP.
Tuttavia, mi è capitato di recente che un tecnico mi chiedesse lumi sull'acronimo SAML (Security Assertion Markup Language). In effetti, anche un esperto di informatica, se non è specializzato nel campo della sicurezza e della crittografia, potrebbe non aver mai avuto a che fare con lo standard SAML.
In linea di massima, io adotto la regola di inserire nel Glossario TUTTI gli acronimi presenti nel documento (ad eccezione dei più universalmente noti), sforzandomi tuttavia di ridurre al minimo indispensabile la loro presenza nel corpo del documento.
Identificare chiaramente il lettore target, è il primo filtro per individuare il set di termini "candidati" ad entrare nel Glossario.
A presto per approfondire la tematica.
Leggi questo articolo...
Ma colui che dovrà leggere il documento, sarà in grado di interpretare correttamente tali contenuti?
La risposta più facile e "pigra" è SI, ed è la risposta che ci "scarica" dalla responsabilità di un ulteriore sforzo per migliorare la comprensione del documento.
In realtà, è SEMPRE buona norma corredare i nostri documenti di un Glossario, cioè di una raccolta specifica e circoscritta dei termini specialistici presenti nel documento, accompagnati dalle relative spiegazioni.
Quali sono i principali criteri da utilizzare per costruire un Glossario?
- Focalizzare l'audience del documento
- Scegliere i termini da inserire
- Progettare un design essenziale
- Gestirne l'evoluzione nel tempo
Avendo chiari in mente questi 4 punti cardinali, siamo già a buon punto.
FOCALIZZARE L'AUDIENCE DEL DOCUMENTO
Come sempre, scriviamo per qualcuno. Una delle regole auree della scrittura tecnica ci impone di immaginare chi leggerà il nostro documento.
E' un principiante? Allora dovremo inserire nel Glossario anche le voci che non metteremmo se invece ci rivolgiamo ad un utente esperto. Se il mio manuale parla del funzionamento di un software e lo legge un Ingegnere Informatico, forse non devo spiegare cosa sia una GUI (Graphic User Interface).
Altrimenti, è preferibile inserire tale acronimo nel Glossario.
Idem per altri acronimi, quali CPU o RAM o SOAP.
Tuttavia, mi è capitato di recente che un tecnico mi chiedesse lumi sull'acronimo SAML (Security Assertion Markup Language). In effetti, anche un esperto di informatica, se non è specializzato nel campo della sicurezza e della crittografia, potrebbe non aver mai avuto a che fare con lo standard SAML.
In linea di massima, io adotto la regola di inserire nel Glossario TUTTI gli acronimi presenti nel documento (ad eccezione dei più universalmente noti), sforzandomi tuttavia di ridurre al minimo indispensabile la loro presenza nel corpo del documento.
Identificare chiaramente il lettore target, è il primo filtro per individuare il set di termini "candidati" ad entrare nel Glossario.
A presto per approfondire la tematica.
Leggi questo articolo...
martedì 31 gennaio 2012
Quanto tempo ti serve per scrivere "QUESTO" documento?
E' lei... è la "domanda delle 100 pistole".
E' il quesito che ti pone il committente, che sulla base della risposta che fornirai sarà pronto, in un decimo di secondo, a calcolare il rapporto costo/beneficio della tua presenza professionale in quel momento ed in quel luogo, valutando la tua effettiva utilità in funzione della scadenza entro la quale il documento dovrà essere PRONTO!
In altre parole, la tua risposta sta al tuo successo professionale come la mezzanotte alla carrozza di Cenerentola; dopo tale ora, CHE TU STESSO avrai fissato (spesso con un tocco di ineffabile masochismo...), se il tuo lavoro non sarà finito rischierai di vedere la carrozza trasformarsi in zucca... e nessuna fatina buona sarà lì ad aiutarti!
E' anche uno dei temi classici in cui ci si arrovella nei gruppi di Linkedin, dove ciclicamente qualche ottimista interroga i colleghi sperando di ricevere in dono la Formula Aurea, la Pietra Filosofale o l'indirizzo preciso della radura dove pascola l'Unicorno, la Risposta Ultima, che una volta rivelata ci solleverà da tutte le nostre angosce, dalle consegne sempre sul filo... e se va bene sul filo... ma anche oltre!
Ora, aldilà dell'ironia, il problema di stimare i tempi di realizzazione di un documento, dipende da molteplici fattori, quasi mai classificabili in modo completo, dipendenti da troppe variabili spesso in contraddizione.
In questi casi, ci vengono in aiuto le regole e le metriche suggerite dall'esperienza e dalla statistica.
In questo solco, vi propongo una tabella interessante stilata dalla Writing Assistance Inc. (WAI), un'azienda specializzata nella fornitura di servizi di Comunicazione Tecnica, di cui vi ho già parlato nel post di inizio anno.
Di seguito, un estratto:
Vediamo, ad esempio, che per un Online Help, l'intero processo di sviluppo viene stimato tra le 3 e le 6 ore per pagina; in questo caso la stima mi sembra ragionevole.
Di contro, per un Operator's Manual di 200 pagine, la tabella prevede fino ad un massimo di 1000 ore (200 x 5 ore) di lavoro, cioè 125 giorni di lavoro uomo; devo dire che nella mia esperienza non ho mai avuto così tanto tempo a disposizione per scrivere un manuale di 200 pagine!
Diciamo che forse la WAI tende anche a "tirare l'acqua al suo mulino", proponendo stime che in alcuni casi presentano una "forchetta" di variazione un pò troppo ampia.
Ognuno potrà farsi la sua opinione, consultando la tabella completa.
E' ovvio che il committente tenderà sempre a comprimere i tempi verso il limite più basso possibile, ma aldisotto di una certa soglia qualsiasi stima diventa solo un numerello, messo lì per sporcare la carta, che non potrà essere credibile.
Queste tabelle forniscono un riferimento sul quale misurare la nostra esperienza professionale, nel tentatvo di ridurre il tasso di errore che quasi sempre caratterizza il tentativo di dare una risposta sensata alla domanda indicata nel titolo.
Provate a darci un occhio e fatemi sapere se e quanto riscontra con la vostra esperienza.
Alla prossima.
Leggi questo articolo...
E' il quesito che ti pone il committente, che sulla base della risposta che fornirai sarà pronto, in un decimo di secondo, a calcolare il rapporto costo/beneficio della tua presenza professionale in quel momento ed in quel luogo, valutando la tua effettiva utilità in funzione della scadenza entro la quale il documento dovrà essere PRONTO!
In altre parole, la tua risposta sta al tuo successo professionale come la mezzanotte alla carrozza di Cenerentola; dopo tale ora, CHE TU STESSO avrai fissato (spesso con un tocco di ineffabile masochismo...), se il tuo lavoro non sarà finito rischierai di vedere la carrozza trasformarsi in zucca... e nessuna fatina buona sarà lì ad aiutarti!
E' anche uno dei temi classici in cui ci si arrovella nei gruppi di Linkedin, dove ciclicamente qualche ottimista interroga i colleghi sperando di ricevere in dono la Formula Aurea, la Pietra Filosofale o l'indirizzo preciso della radura dove pascola l'Unicorno, la Risposta Ultima, che una volta rivelata ci solleverà da tutte le nostre angosce, dalle consegne sempre sul filo... e se va bene sul filo... ma anche oltre!
Ora, aldilà dell'ironia, il problema di stimare i tempi di realizzazione di un documento, dipende da molteplici fattori, quasi mai classificabili in modo completo, dipendenti da troppe variabili spesso in contraddizione.
In questi casi, ci vengono in aiuto le regole e le metriche suggerite dall'esperienza e dalla statistica.
In questo solco, vi propongo una tabella interessante stilata dalla Writing Assistance Inc. (WAI), un'azienda specializzata nella fornitura di servizi di Comunicazione Tecnica, di cui vi ho già parlato nel post di inizio anno.
Di seguito, un estratto:
Vediamo, ad esempio, che per un Online Help, l'intero processo di sviluppo viene stimato tra le 3 e le 6 ore per pagina; in questo caso la stima mi sembra ragionevole.
Di contro, per un Operator's Manual di 200 pagine, la tabella prevede fino ad un massimo di 1000 ore (200 x 5 ore) di lavoro, cioè 125 giorni di lavoro uomo; devo dire che nella mia esperienza non ho mai avuto così tanto tempo a disposizione per scrivere un manuale di 200 pagine!
Diciamo che forse la WAI tende anche a "tirare l'acqua al suo mulino", proponendo stime che in alcuni casi presentano una "forchetta" di variazione un pò troppo ampia.
Ognuno potrà farsi la sua opinione, consultando la tabella completa.
E' ovvio che il committente tenderà sempre a comprimere i tempi verso il limite più basso possibile, ma aldisotto di una certa soglia qualsiasi stima diventa solo un numerello, messo lì per sporcare la carta, che non potrà essere credibile.
Queste tabelle forniscono un riferimento sul quale misurare la nostra esperienza professionale, nel tentatvo di ridurre il tasso di errore che quasi sempre caratterizza il tentativo di dare una risposta sensata alla domanda indicata nel titolo.
Provate a darci un occhio e fatemi sapere se e quanto riscontra con la vostra esperienza.
Alla prossima.
Leggi questo articolo...
Iscriviti a:
Post (Atom)
