La stesura della documentazione è, da sempre, uno dei più grossi limiti di ogni programmatore. Nell'immediato ci sembra sempre tutto chiaro e limpido ma , dopo un paio di mesi (ed "n" salti da una procedura all'altra), la nebbia ed il mistero si infittiscono... E, quando un collega (tipicamente dell'area Consulenza) ci pone una domanda di cui non ricordiamo la risposta (praticamente tutte, nel mio caso...), iniziamo a sguazzare in un mare di righe di codice....
Ecco perché, da qualche tempo, sono diventato un ragazzo "preciso"... Documento tutto il possibile, allo sfinimento.... Beh, diciamo la verità : tante cose mi scappano (o, meglio, me le faccio scappare : non sono mica il Manzoni !!!!)
Adesso ho un bel problema : devo documentare dei files XML, fornitimi da terze parti. Sono files che utilizzerò per realizzare un'interfaccia, partendo dai dati del "mio" gestionale opportunamente trasformati con XSLT.
Il problema è la stesura di un manuale (rigorosamente stampabile) che contenga i nodi del file di destinazione (magari strutturati ad albero) con una serie di informazioni quali il tipo, la lunghezza massima, il numero di ripetizioni e, soprattutto, la sorgente del dato.
La sola cosa che mi è venuta in mente è l'utilizzo di Word e delle sue tabelle (o dei suoi Bullets)... Ma temo di andarmi a ficcare in un ginepraio...
Qualche idea ?