Scrivere articoli sugli standard del Web

Nel corso degli ultimi due anni la mia passione per gli standard mi ha portato a scrivere numerosi articoli tecnici. Ecco alcuni consigli per scrivere al meglio i nostri articoli senza avere la pretesa di aver trovato la soluzione ideale.

Siate chiari

La chiarezza è una delle massime chiave dell'usabilità  della scrittura sul Web. Applicate sempre quello che diceva Albert Einstein, il quale sosteneva che se si è capito qualcosa si dovrebbe essere in grado di spiegarlo anche alla propria nonna. Usate un approccio passo passo, senza dare in pasto al lettore frammenti di codice o esempi non commentati.

Documentatevi

Assicuratevi sempre di aver compreso appieno uno standard prima di scrivere qualcosa su di esso. Leggete e rileggete le specifiche o gli articoli fondamentali su uno standard e poi rifletteteci su. Vedrete che prima o poi troverete una soluzione non nota ad un problema noto.

Testate sempre

Non date mai nulla per scontato. Testate sempre su più browser la soluzione da voi trovata, elencandone i pro e i contro. Specificate sempre su quali browser funziona la vostra soluzione.

Siate dettagliati

È vero che una norma dell'usabilità  prevede di inserire all'inizio dell'articolo un sommario con i contenuti salienti, ed è altrettanto vero che sul Web la lettura procede a salti, ma sicuramente ci saranno alcuni lettori esperti che gradiranno sapere quali sono i dettagli della vostra soluzione.

Usate gli algoritmi

Quando scrivete del codice in un linguaggio di programmazione, fornite sempre l'algoritmo corrispondente in un linguaggio naturale (pseudo-codice). I programmatori che non conoscono il linguaggio di programmazione di cui state parlando lo apprezzeranno senz'altro.

Infine, siate sempre pronti ad accettare di buon grado le critiche costruttive che vi verranno rivolte, soprattutto se queste possono migliorare la qualità  del vostro articolo. Sul Web si applica quello che diceva Flaubert a proposito di George Sand: "L'uomo è niente, l'opera è tutto". Alla prossima!