Índex:

1. Per als impacients.
2. Origen de la idea.
3. Instal·lació.
4. Com generar els diagrames.
5. Funcionalitats futures.
6. Com col·laborar.

Per als impacients:

Per als impacients aqui teniu un parell de screenshots:

...O també ho podeu veure "en acció" a:

Origen de la idea:

Fa poc he estat "cridat a files" al projecte Bulmagés perque s'estava pensant en arrancar el mòdul de facturació i TPV (actualment Bulmagés només és comptabilitat) i com que per molts és sabut que jo hi estava interessat i, de fet, ja estava fent cosetes pel meu compte, em van demanar de col·aborar-hi.

La idea era començar amb un TPV perque hi ha una persona a qui li interessa i està disposat a currar-hi per tenir-lo enllestit en poc temps. Va be marcar-se objectíus i aquest és un fàcilment assumible.

Però tots vam coïncidir en que fer un TPV sense abans tenir definida la Base de Dades de tota la gestió suposaria que en posar-nos amb aquesta segurament hauriem de fer canvis seriosos a la implementació del TPV, cosa que és duplicar feina.

Per això vam agafar la documentació de la "mitja gestió" que jo tenc funcionant a la empresa a la que treball com a base per fer el disseny de la base de dades de la futura BulmaFACT. I el primer problema que ens vam trobar és que aquell diagrama no es correspòn al 100% amb la base de dades actual perque aquesta ha sofert modificacions que no sempre he disposat de temps d'actualitzar al model Entitat-Relació i fer-ho quadrar amb el relacional i l'SQL de la Base de dades.

Per tant, vaig haver de partir del model ER que tenia i repescar les millores de notes soltes i de consultes directes sobre la BD en producció. I, lògicament, és previsible que el resultat sigui objecte de modificacions futures ja que es pretén que tot-hom que hi estigui interessat pugui participar en el desenvolupament del projecte.

A més, això afegeix una complicació extra: Si moltes persones han de participar en el disseny del model de dades, és difícil que tots entenguin a la perfecció la finalitat d'entitats o camps concrets col·locats per altres persones. Si això ja és un problema quan el disseny de la base de dades la fa una sola persona i hem d'anar prenent nota dels nostres propis pensaments per ser capaços d'entendre'ls en el futur, imaginau quan han de ser entesos per moltes persones.

Aleshores, necessitavem un model ER:

1. Fàcilment modificable
2. Ràpid de consultar
3. Fàcilment comprensible
1. Tant per l'autor...
2. ...com per terceres persones que ho hagin de consultar.
4. I si no és molt demanar que modificant una sola fase del disseny, la resta es puguin generar automàticament.

Crec que els tres primers punts els hem aconseguit. I el quart està en el TO-DO (el projecte és jove encara ;-)) però pens que no serà gaïre difícil d'assolir.

Per entendre la idea, si pensam en la naturalesa d'un diagrama ER, veurem que consta de dues parts:

• Una llista d'entitats amb la corresponent enumeració dels camps que la composen i amb identificacio del camp o camps que formen la clau primaria.
• Un esquema gràfic on es representen aquestes entitats i les relacions que hi ha entre elles (que, com sabem, de vegades poden contenir algún camp de dades).

La llista d'entitats és fàcil i es pot fer amb qualsevol editor de text pla (vi comes for help! :-)). Però com més gran és el quocient entre el número de relacions i el d'entitats, més difícil és conseguir una representació gràfica clara i llegible (fins i tot amb llapis i paper) de les relacions existents entre les entitats. Per això és tan difícil trobar una eina CAD adequada.

Com que això suposava un gran contratemps vaig decidir, en comptes de dibuixar el diagrama, redactar també una llista de les relacions indicant les entitats que relacionen, amb quina cardinalitat i, si en tenen, els camps de dades pertinents i que cadascú es dibuixi, si vol, el seu propi diagrama del que l'interessi, però que el format "oficial" del model ER seria el text pla.

Amb això es sol·lucionava el punt 1 ja que, per exemple, per afegir una relació al diagrama res més ràpid que escriure-la. I així sorgí la idea que solucionaria el punt 2, perque Crear una aplicació capaç de llegir i indexar tota aquesta informació era relativament trivial i, si be plasmar-la tota de cop i que quedi llegible és, com hem dit, poc menys que impossible, representar una entitat i davora totes les entitats amb que es relaciona i dibuixar-ne les relacions, també era un problema relativament senzill.

El problema hagués estat fer-ho a ma (repetició de feina) o consultar-ho (anar envant i enrera per un munt de pàgines per seguir el traçat de l'esquema). La idea però, era fer aquesta mateixa representació en format web de manera que, hiperenllaçant les entitats, aquesta navegació es convertiria en instantània.

Ara només ens quedava el punt 3: Fer que el diagrama fos fàcilment comprensible. En primer lloc pel propi autor, tasca que, com tots sabem, correspòn a un document apart del model ER anomenat Diccionari de Dades i que s'ha de fer al mateix temps que es dissenya el model ER perque si no després no ens recordam de perquè eren la meïtat de coses. Però que a la pràctica tot-hom ho feia després per lo engorrós que resulta passar constantment del ratolí al teclat i vice-versa (ara podem, per exemple, tenir dues pestanyes del konsole amb vim per editar simultàniament MER i DD sense haver d'utilitzar el ratolí per res. A més, ara ja no cal consultar-lo apart, sino que les descripcions dels camps ens surten davora aquests per a l'entitat que estam consultant i en un requadre emergent en passar el ratolí per damunt (anchor amb 'title') per als camps de les entitats filles i les relacions.

...i en segon lloc, per a terceres persones, cas en el qual només queda desitjar que l'autor hagi pres bones notes del que ha fet i de perquè ho ha fet si no volem haver de preguntar-li (o si ell no vol que li preguntin :-P).

Però així i tot, per a qui no les ha escrites, pot ser complicat trobar una nota en el moment que la necessita. Per aquesta raó, l'aplicació també interpreta certs marcadors que podem utilitzar dins el fitxer de notes per:

• Delimitar seccions (amb jerarquia).
• Marcar les notes com a "TO-DO notes" (coses a fer) que surten en vermell, o "Recordatoris o coses fetes".
• "Enganxar" la nota a una o vàries entitats o relacions determinades.

Finalment, si existeix un fitxer anomenat CHANGELOG.txt, a la vista general del diagrama surt reproduït a davall de manera que si tenim diferentes versions podem anar anotant els canvis que anam fent en comparació a la versió anterior.