Posts
163
Comments
179
Trackbacks
5
L'importanza della documentazione

In questi giorni sono veramente stressato! Sono alla prese con l'integrazione di un web service sviluppato da una compagnia straniera.
Il suddetto web service viene accompagnato con un file .chm che "dovrebbe" illustrare e descrivere i vari metodi disponibili. I metodi elencati in questa "reference" sono 12, tutti con la stessa signature: file XML in input e file XML in output.

La prima sopresa è che se ci si collega al web service i metodi che si trovano non sono 12 ma bensì 17. Quindi 5 sono magicamente scomparsi dalla documentazione o comparsi nel web service! Se siano utili o meno non lo so ancora, ma dal nome potrei intuire che potrebbero anche essere necessari.

Comunque passiamo oltre. Vista la signature delle funzioni mi sarei aspettato che almeno la struttura dei file XML di input e di output fosse descritta a sufficienza. Mi aspettavo che i vari tag, i vari attributi e i vari valori da specificare fossero dettagliati nella documentazione e che magari ci fossero esempi per i casi principali. Ovviamente non è così! Nella documentazione sono descritti i nodi "root" del file XML e gli attributi principali. Gli eventuali nodi figli (che NON sempre sono opzionali) e tutti gli altri attributi sono lasciati all'immaginazione del povero programmatore. Per fortuna insieme al file .chm sono disponibili anche una serie di file .XSD che permettono di capire come devono essere costruiti i file XML, anche se la maggior parte degli attributi sono di tipo stringa e non c'e' modo di sapere quali valori è possibile specificare.

Il risultato qual'e': si va a tentoni, provando, riprovando, contattando l'assistenza tecnica, inviando file XML errati e ricevendo in risposta le modifiche da effettuare. Per fortuna ogni tanto il web service (scritto in .NET) restituisce eccezioni in cui viene data una qualche indicazione sui nodi e sugli attributi mancanti.

Quello che mi chiedo è: visto che non c'e' un canone di assistenza, ne esiste un costo per ogni "ticket" o email inviate all'assistenza, non era meglio curare la documentazione ed evitare le decine di segnalazioni che presumo saranno inviate da programmatori come me?

posted on giovedì 11 ottobre 2007 12:02 Print
Comments
Gravatar
# re: L'importanza della documentazione
Fabio
27/11/2007 15:01
Mi auguro solo che, per la Tua sanità mentale, la compagnia straniera non sia una multinazionale svedese....

Capisco che sia particolarmente difficile redigere un manuale che documenti la struttura di un file XML, ma, forse, avrebbe meritato qualche sforzo in più...

fg
Comments have been closed on this topic.
News
Se volete sapere con chi avete a che fare eccomi qui in uno "scatto" lavorativo.

La mia foto

Logo MCAD
Logo MCTS