{"id":90073,"date":"2017-01-13T11:14:36","date_gmt":"2017-01-13T10:14:36","guid":{"rendered":"http:\/\/artigianodelsoftware.it\/blog\/?p=90073"},"modified":"2017-01-13T11:14:36","modified_gmt":"2017-01-13T10:14:36","slug":"dalla-pagina-bianca-alla-documentazione","status":"publish","type":"post","link":"https:\/\/artigianodelsoftware.it\/blog\/2017\/01\/13\/dalla-pagina-bianca-alla-documentazione\/","title":{"rendered":"Dalla pagina bianca alla documentazione"},"content":{"rendered":"
\"image_pdf\"<\/a><\/a><\/div>
\n

Una nuova esplorazione<\/h1>\n<\/blockquote>\n

Con questo post iniziamo una nuova esplorazione nel mondo dei Wiki<\/strong><\/em>. Affrontiamo uno dei problemi maggiori nel campo: Come andiamo a redigere una documentazione<\/em> <\/strong>che abbia un senso<\/em> e che permetta, un domani, di essere \u00a0condivisibile e permetta agli utenti di avere a disposizione un percorso di lettura\u00a0valido, sensato e coerente.<\/p>\n

<\/p>\n

\n

Da cosa partire<\/h1>\n<\/blockquote>\n

Avere le idee chiare<\/h2>\n

La prima cosa che occorre fare \u00e8 sicuramente cercare di classificare tutte le informazioni e gli utenti che andranno a referenziarle. In questo modo abbiamo riusciamo ad avere una prima indicazione di come classificare le informazioni, in quali SPACE andare a inserirle, se abbiamo bisogno di collegare delle informazioni, etc etc etc<\/p>\n

<\/p>\n

Questo ovviamente \u00e8 solo l’inizio. Occorre studiare bene questa prima parte, per un motivo molto semplice: Inserire delle informazioni a caso su di un Wiki non ha praticamente senso<\/strong><\/em>. Faccio un esempio molto semplice: Se si inseriscono delle pagine a caso e queste non sono collegate tra di loro (aggiungo anche: collegate in maniera opportuna, ma nella maniera pi\u00f9 improbabile), questo significa che abbiamo solo un caos semi-disorganizzato<\/em>, che non ci aiuta minimamente nel reperire le info. Passeremo le nostre giornate a ricercare le informazioni. Lo strumento non ci aiuter\u00e0 in nessun modo \ud83d\ude41 e la prima reazione sar\u00e0 quella di copiare le informazioni in locale sul nostro PC\/tablet.<\/p>\n

<\/p>\n

Fate sempre ordine<\/h2>\n

Occorre studiare come inserire le informazioni e come organizzarle, classificarle, collegarle. Questo ultimo punto \u00e8\u00a0sicuramente il pi\u00f9 importante in quanto anche delle belle pagine chiare e illuminanti non hanno alcun senso se non sono collegate tra di loro.\u00a0Occorre mettersi in testa che l’utente non deve fare la caccia al tesoro per reperire le informazioni.<\/p>\n

<\/p>\n

Non seguire le mode…<\/h2>\n

Molto spesso si commette l’errore che basti introdurre lo strumento in azienda o semplicemente adottarlo per risolvere tutti i problemi di documentazione<\/a>, come avevo gi\u00e0 indicato in questo post, in cui ho riportato\u00a0una prima serie di considerazioni sulla documentazione su Wiki.<\/p>\n

<\/p>\n

Se le informazioni sono collegate in maniera tale da creare dei percorsi di lettura, quello che si ottiene \u00e8\u00a0una documentazione valida<\/em>.<\/p>\n

\n

Obbiettivo di questi post<\/h1>\n<\/blockquote>\n

Con questa nuova serie di post, ci prefiggiamo l’obbiettivo di fornire una serie di consigli per gli utenti, inteso pi\u00f9 come un nuovo modo di ragionare e di organizzare le informazioni che porti gli utenti ad avere a disposizione una documentazione il pi\u00f9 possibile fruibile ed utile.<\/p>\n

<\/p>\n

Non intendo fornire tanto delle norme rigide ed immodificabili, ma quanto una serie di consigli e di punti di attenzione che possono aiutare nella redazione della documentazione e nell’organizzazione della stessa. La vera potenzialit\u00e0 dei prodotti Atlassian risiede proprio nel grado di libert\u00e0 che si ha a disposizione \ud83d\ude42<\/p>\n

<\/p>\n

\n

In conclusione<\/h1>\n<\/blockquote>\n

Chiudiamo qui questo post introduttivo. Abbiamo ripreso quanto avevo gi\u00e0 indicato in altri post e cerchiamo di esploderlo nei prossimi post con esempi pratici, modalit\u00e0 di ragionamento e, importantissimo, uso corretto della testa \ud83d\ude42<\/p>\n

<\/p>\n

Likes(1<\/span>)<\/span>Dislikes(0<\/span>)<\/span><\/div>","protected":false},"excerpt":{"rendered":"

Una nuova esplorazione Con questo post iniziamo una nuova esplorazione nel mondo dei Wiki. Affrontiamo uno dei problemi maggiori nel campo: Come andiamo a redigere una documentazione che abbia un senso e che permetta, un domani, di essere \u00a0condivisibile e<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_editorskit_title_hidden":false,"_editorskit_reading_time":0,"_editorskit_is_block_options_detached":false,"_editorskit_block_options_position":"{}","footnotes":""},"categories":[3,4,7,119],"tags":[34,35,48,56,58,82],"_links":{"self":[{"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/posts\/90073"}],"collection":[{"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/comments?post=90073"}],"version-history":[{"count":7,"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/posts\/90073\/revisions"}],"predecessor-version":[{"id":92493,"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/posts\/90073\/revisions\/92493"}],"wp:attachment":[{"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/media?parent=90073"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/categories?post=90073"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/artigianodelsoftware.it\/blog\/wp-json\/wp\/v2\/tags?post=90073"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}