Tales from the Machine Room


Home Page | Comments | Articles | Faq | Documents | Search | Archive | Tales from the Machine Room | Contribute | Login/Register

Documentation is nice, Documentation is good...

Allora, ritorniamo a parlare della famosa applicazione di quella gente di cui avevo detto un po' di tempo fa. Dopo i vari casini che si erano verificati, l'UL in carico della situazione aveva deciso che la cosa migliore da fare era... rifare tutto da capo. Ma con un altro programmatroto ed in modo completamente diverso.

Ragion per cui erano stati installati altri 8 servers, con JBoss e TomCat (?) e le varie applicazioni suddivise in modo che uno dei server facesse funzionare questo-e-quello mentre l'altro facesso quest'altro-e-quell'altro e cosi' via. Con il risultato che non ci si capisce piu' un tubo e per un rilascio bisogna andare a cercare roba in giro per il mondo. Tra l'altro, non contenti del casotto iniziale, hanno anche deciso di spostare le applicazioni in giro.

Dopo una serie di madonne da fare invidia ad uno scaricatore di porto turco, sono riuscito a farmi una vaga idea di come le cose funzionano ed ho scritto uno straccio di documentazione dove si spiega la rava e la fava ed e' presente una breve procedura di rilascio.

Procedura che e' una roba del tipo

  1. Attivare pagina di manutenzione su firewall X con linea Y
  2. Attivare pagina di manutenzione su server X con linea Y
  3. Eseguire backup del database usando script K su server Z
  4. Eseguire backup applicazioni su server 1..8 con script...

E cosi' via. Ora, la documentazione finisce con un bel "quando ho scritto sta roba funzionava, se fate dei cambiamenti all'ambiente aggiornate la documentazione grazie". No, che qualcuno aggiorni la documentazione non ci credo manco io, ma tante'...

Comunque sia. Le cose vanno piu' o meno con la mia documentazione che funziona. Solo che poi questa gente comincia a fare 'n' rilasci in test e poi riportare tutto di botto in produzione. Ovviamente l'idea di fare un rilascio "omnicomprensivo" che contiene tutto e' al di la' della loro comprensione, quindi si limitano a ripassarci tutte le versioni che devono essere riportate una per una (nella giusta sequenza) sui server di produzione in modo da avere l'applicazione funzionante.

Tutto questo solo per descrivere il casotto. Comunque sia, arriva il giorno in cui questo branco di allupati domanda un rilascio sul sistema di produzione. Rilascio che e' l'accumulo di 3 o 4 rilasci precedenti. E quella mattina, per svariati motivi, io sono impegolato a cercare di risolvere un problema di rewrite e redirects circolari su Apache. Ondepercuicio, quando uno dei miei colleghi mi dice che del rilascio se ne occupa lui, io casco dalle nuvole perche' manco ho visto la mail. Ma dato che dice che "se ne occupa lui" io non mi preoccupo piu' di tanto.

Almeno fino a che il telefono non comincia a suonare. Ed ovviamente e' l'UL della situazione che si lamenta che la pagina di manutenzione in corso non compare ed il sito e' irraggiungibile e che la versione sbagliata compare adesso in produzione e che questo-e-quell'errore sono riportati da questo-e-quel servizio... Il che mi fa pensare che il famoso collega che sta procedendo al rilascio non ha letto la documentazione.

IO - (rivolto al suddetto collega, d'ora in avanti CL) Yoh! Ancora occupato con il rilascio di quella gente?
CL - Si', e' un casino.
IO - Che e' un casino lo sapevano tutti, hai letto la documentazione?
CL - Ho qui la lista che ha passato il programmatroto.
IO - Si bene, ma a parte quella, hai anche letto la documentazione di rilascio che abbiamo nel wiki?
CL - No, ho qui la lista del programmatroto.
IO - Ah bene, allora di passo UL che ha qualche domanda per te.

Ovviamente l'UL in questione ripete le sue germiadi a CL, il quale ripete a pappagallo che "ha la lista del programmatroto". Il fatto che tale lista riporti cose generiche e non dica nulla di cose come "pagine di manutenzione" et similia e' un particolare trascurabile. Comunque sia, CL si piglia la scaldata e poi viene a domandare a me.

CL - Ma c'e' una pagina di manutezione per quel sito?
IO - Probabilmente si, ma se c'e' e' scritta nella documentazione.
CL - E c'e' una procedura per il backup del database?
IO - Se c'e' e' nella documentazione.
CL - E c'e' una sequenza...
IO - Quale parte di leggi la foxxuta documentazione non era chiara?

Perche' la documentazione e' una gran rottura da scrivere e da mantenere, se poi nessuno la legge mai e' anche peggio.

Davide
23/01/2012 08:00

Previous Next

Comments are added when and more important if I have the time to review them and after removing Spam, Crap, Phishing and the like. So don't hold your breath. And if your comment doesn't appear, is probably becuase it wasn't worth it.

12 messages this document does not accept new posts
Alberto By Alberto - posted 23/01/2012 08:48

È sempre bello cominciare la settimana leggendo la storia di una situazione classica.

http://tcritic.com/wp-content/uploads/2006/09/rtfm.jpg

 

Buona settimana a tutti

--
Alberto


PAP400 By PAP400 - posted 23/01/2012 09:03

>> Perche' la documentazione e' una gran rottura da scrivere e da mantenere, se poi nessuno la legge mai e' anche peggio.

AMEN!

 

PAP

 

--
PAP400


Anonymous coward By Anonymous coward - posted 23/01/2012 11:17

l'unica documentazione che oramai  scrivo sono le attivita' passo-passo che devo fare acciocche' le cose funzionino, se gli altri non le leggono, che s'impicchino.

PS: al punto "erano stati installati altri 8 servers" ho capito che sarebbe finita nell'ennesimo bagno di letame...

--
Anonymous coward


Luca BG By Luca BG - posted 23/01/2012 12:47

Ma è bello anche quando la scrivi, e qualcuno la legge e poi ti telefona alle due di notte dicendo "Ciao, nel documento c'è scritto Alfa Beta Gamma. Mi confermi che devo fare Alfa Beta Gamma?" Cos'è, hai paura di un attacco man in the middle sul documento che ti ho inviato poche ore fa?

--
Luca BG


Il codardo senza nome By Il codardo senza nome - posted 23/01/2012 13:52

Quelli che leggono  i manuali sono  una specie in via d'estinzione....

--
Il codardo senza nome


Tony Stark By Tony Stark - posted 23/01/2012 15:17

Il caro buon vecchio RTFM :D

--
Tony Stark


Nik By Nik - posted 23/01/2012 20:49

Non solo gli utonti... anche i colleghi ci si mettono... frown

--
Chronicles of a Broken Heart


Messer Franz By Messer Franz - posted 24/01/2012 09:42

Una volta , vendendo hardware , si diventava ricchi. Ora la percentuale di soldini che ti entrano in tasca è molto piu' esigua , ed e' tanto se sopravvivi (almeno in italia) .

Quindi mi chiedevo come facevano tanti negozi a , appunto , sopravvivere. Leggendo le tue storie l'ho capito : la meta' iniziano con "sono stati acquistati 8 nuovi server" e cose simili ... o forse hanno inventato i server usa e getta , che ogni programmatroto deve gettare appena ha passato l'incarico ad un altro programmatroto?

 

E , comunque , non prendertela troppo col tuo collega : probabilmente non si ricorda nemmeno piu' cos'è una "documentazione"...penso , da che ti seguo (2004) che sia la prima storia in cui la si nomina con le parole "c'e' una" davanti non precedute da un "NON"....

--
Messer Franz


admiral0 By admiral0 - posted 25/01/2012 16:18

In questo caso è un RTFW.

--

admiral0

--
admiral0


Francesco Paolini By Francesco Paolini - posted 29/01/2012 19:04

La documentazione è fatta per non essere letta. Punto.

Perchè ti meravigli?

In fin dei conti, di quanti televisori/frullatori/cellulari avuti abbiamo letto il manuale?

--
Francesco Paolini


Francesco Paolini@ Francesco Paolini By Francesco Paolini - posted 01/02/2012 21:34

 

> In fin dei conti, di quanti televisori/frullatori/cellulari avuti abbiamo letto il manuale?

 

Anzi, mi correggo:

In fin dei conti, di quanti televisori/frullatori/cellulari avuti abbiamo letto il manuale solo dopo aver avuto un problema e provato di tutto per risolverlo da soli?

--
Francesco Paolini


Anonymous coward By Anonymous coward - posted 30/01/2012 17:01

strano... non mi è mai capitato... da me non leggono nemmeno le istruzioni che metto nelle mail tipo:

scompatta il file -> xcopy nella folder X

 

semplicemente per "non sbagliarerompono gli zebedei... 

--
Anonymous coward


12 messages this document does not accept new posts

Previous Next


This site is made by me with blood, sweat and gunpowder, if you want to republish or redistribute any part of it, please drop me (or the author of the article if is not me) a mail.


This site was composed with VIM, now is composed with VIM and the (in)famous CMS FdT.

This site isn't optimized for vision with any specific browser, nor it requires special fonts or resolution.
You're free to see it as you wish.

Web Interoperability Pleadge Support This Project
Powered By Gojira