Crèdit de síntesi

La documentació que cal presentar al crèdit de síntesi serà, com a mínim, la descrita en el present article.

Lliurament de la documentació

• Entrega oficial de tot el material al vostre moodle corresponent.
• Recomanat fer-ho en wiki, enlloc de documents pdf.
• Si hi ha màquines virtuals implicades en el projecte, cal entregar-les en un DVD/pendrive (no retornable)
• En cas que s'exigeixin còpies escrites (consultar el vostre cicle concret):
  • Entrega dels arxius en un suport CD/DVD/pendrive (no retornable).
  • 2 còpies de la documentació impreses. Després de la defensa podreu recuperar una de les dues còpies.
  • Podeu posar els documents per separat (cadascú amb el seu índex) i enquadernats junts amb separadors (preferentment de plàstic) entre cada document.
  • Algun marcador per accedir fàcilment a cada document imprès serà apreciat també.

Documentació

Manual d'usuari/administrador

• Obligatori fer-ho en wiki.
• Recull de procediments per tal que els nostres clients puguin utilitzar els serveis prestats per la nostra empresa/projecte
  • Instal·lació en màquines client
  • Registre d'usuaris
  • Reclamacions al webmaster
  • Operativa del servei
  • ...

Manual tècnic d'instal·lació/desplegament

• Obligatori fer-ho en wiki.
• Recull de procediments per posar en marxa el projecte en producció.
  • ASIX: instal·lació de SO, VMs, softwares, middleware, scripts, configuracions a aplicar, etc.
  • DAW: procediment per posar en producció en un VPS tipus AWS
• Cal detallar totes les passes per tal que algú que s'incorpori nou al grup (amb coneixements mínims d'informàtica) sigui capaç de posar en marxa el projecte. No doneu res per suposat, expliqueu-ho.
• Seguiu les normes de presentació de treballs habituals del vostre cicle.
• Han d'aparèixer totes les comandes utilitzades (ressaltades) i pantallades explicatives.
• Sistema de generació del BACKUP i RESTORE. Recuperació de desastres (ha d'estar provat).
• ...

Memòria tècnica

És un "calaix de sastre" on posar tot el què no encaixa als manuals anteriors.

• Optatiu fer-ho en wiki o en PDF.
• Document general que inclou tot el treball fet durant el crèdit de síntesi (i que no estigui als manuals).
• Inclou objectius i requeriments tècnics del projecte.
• Explicació teòrica i filosòfica. No es requereix gran nivell de detall (això es deixa pel manual d'instal·lació).
• Diagrames i esquemes de l'arquitectura i processos del sistema.
  • Una imatge val més que mil paraules'
  • Digrama de classes
  • Diagrama de l'arquitectura
  • Diagrama de la base de dades
  • etc.
• Ha d'incloure les justificacions de les eleccions de programari, maquinari, etc.
• Heu d'explicar les proves i tests de diferents opcions provades abans de la tria final.
• Recomanable fer proves de profiling i comparatives.
• Estudis econòmics del desplegament o posada en producció.
• Sprints
  • Especificacions inicials del projecte (sprint 0)
  • Dates del sprint
  • Objectius plantejats al principi del sprint.
  • Captures del kanban durant els diferents sprints (normalment a l'acabar cadascun).
• Incidències durant el projecte
  • Què ha costat més de l'esperat
  • Que ha estat més fàcil de l'esperat
• Línies de futur
• Presentació / demo (diapositives, vídeos, etc.)

Pla d'empresa

Segons les directrius donades a l'assignatura de EIE.

Presentació per la defensa

El dia de la defensa es recomana que porteu una presentació amb diapositives per ajudar-vos en l'explicació. Aquesta ha d'incloure:

• Diapo de presentació (nom del projecte i components)
• Introducció
• Presentació comercial. Es recomana en anglès.
• Desenvolupament tècnic del projecte. Aquí és on va la "chicha" amb pantallades, diagrames i on heu de desplegar la feina feta.
• Codi: en els projectes de desenvolupament poseu només petits fragments de codi que il·lustri alguna part poc habitual, plugins i llibreries que heu investigat, etc. Procureu posar el mínim de línies per il·lustrar el funcionament.
• Incidències (parts on us heu encallat).
• Línies futures de desenvolupament (què no heu fet per falta de temps, per complicacions, etc. o per on es podria continuar)
• Precs i preguntes.

Demostració pràctica

Penseu que la presentació ha de portar una DEMOSTRACIÓ PRÀCTICA del projecte. Aquesta ha d'incloure:

• Exemples pràctics del funcionament del projecte

  registre d'un nou client, compra de productes, alta d'un nou usuari de hosting, ús del servei, etc.

• Canvis de configuració del servei/projecte:

  afegir productes, afegir màquines client al sistema, etc.

• BACKUP: heu de mostrar una versió online de la web i una versió offline en el vostre portàtil/PC. La demostració ha de començar per un reboot de la màquina on hi ha el backup.