ANNEX A (normatiu) Nomenclatura dels documents tècnics

A continuació es descriu la nomenclatura dels documents tècnics:

Fase Lliurable Nomenclatura Accés versió MRR Checklist Exemple
Inici Visió i necessitats Assumpte_DT_VIS_Vx.y 0196_GICAR_DT_VIS_V0.1
Inici Oferta a client Assumpte_OFE_CLI_Vx.y ID00056_GICAR_OFE_CLI_V1.0
Inici Oferta de proveïdor Assumpte_OFE_PRO_Vx.y Versió MRR ID00056_GICAR_OFE_PRO_V1.0
Inici Presentació de kick-off Assumpte_PLA_KICK_Vx.y P140005_GICAR_PLA_KICK_V1.0
Planificació Pla de qualitat Versió MRR Assumpte_CHK_Pla de qualitat_Vx.y.xlsx 0196_GICAR_PLA_QUAL_V1.2, 0196_GICAR_PLA_QUAL_AGILE_V1.2
Anàlisi i Disseny Especificació de requisits (Anàlisi funcional) Assumpte_DT_ERQ_Vx.y Versió MRR Assumpte_CHK_ERQ_Vx.y.xlsx 0196_GICAR_DT_ERQ_V1.0
Anàlisi i Disseny Descripció d’Arquitectura Cloud Privat Assumpte_DT_DAQ_CloudPrivat_Vx.y Assumpte_CHK_DAQ_Vx.y.xlsx 0196_GICAR_DT_DAQ_CloudPrivat_V2.2
Anàlisi i Disseny Descripció d’Arquitectura Cloud Públic Gestionat Assumpte_DT_DAQ_CloudPublicGestionat_Vx.y Assumpte_CHK_DAQ_Vx.y.xlsx 0196_GICAR_DT_DAQ_CloudPublicGestionat_V2.2
Anàlisi i Disseny Descripció d’Arquitectura Cloud Públic No Gestionat Assumpte_DT_DAQ_CloudPublicNoGestionat_Vx.y Assumpte_CHK_DAQ_Vx.y.xlsx 0196_GICAR_DT_DAQ_CloudPublicNoGestionat_V2.2
Anàlisi i Disseny Descripció d’Arquitectura Cloud Híbrid Assumpte_DT_DAQ_Híbrid_Vx.y Assumpte_CHK_DAQ_Vx.y.xlsx 0196_GICAR_DT_DAQ_Híbrid_V2.2
Anàlisi i Disseny Descripció d’Arquitectura Cloud On Premise Assumpte_DT_DAQ_OnPremise_Vx.y Assumpte_CHK_DAQ_Vx.y.xlsx 0196_GICAR_DT_DAQ_OnPremise_V2.2
Anàlisi i Disseny Descripció d’Arquitectura Low Code Assumpte_DT_DAQ_LowCode_Vx.y Assumpte_CHK_DAQ_Vx.y.xlsx 0196_GICAR_DT_DAQ_LowCode_V2.2
Anàlisi i Disseny Disseny tècnic detallat Assumpte_DT_DTE_Vx.y Versió MRR 0196_GICAR_DT_DTE_V1.0
Construcció Informe d’anàlisi del codi font Assumpte_IN_REV_CF_Vx.y Versió MRR Assumpte_CHK_CF_V2.0.xlsx 0196_GICAR_IN_CF_V1.2
Anàlisi i Disseny Pla mestre de proves Assumpte_PLA_PMP_Vx.y Versió MRR Assumpte_CHK_PMP_Vx.y.xlsx 0196_GICAR_PLA_PMP_V1.0
Proves Informe de resultat de proves Assumpte_IN_RPt_Vx.y, On t pot variar segons el tipus de resultat de proves Versió MRR 0196_GICAR_IN_RPI_V1.2, 0196_GICAR_IN_RPQR_V1.3, 0196_GICAR_IN_RPQF_V1.2, 0196_GICAR_IN_RPA_V1.2
Proves Informe de defectes Assumpte_IN_DEF_Vx.y Versió MRR Versió MRR 0196_GICAR_IN_DEF_V1.2
Entrada en servei Qüestionari d’avaluació de qualitat Assumpte_Q_AVQ_Vx.y 0196_GICAR_Q_AVQ_V1.0
Entrada en servei Pla de millores de qualitat Assumpte_PLA_MIL_Vx.y Versió MRR 0196_GICAR_PLA_MIL_V1.2
Entrada en servei Manual d’explotació Assumpte_MAN_EXP_Vx.y Versió MRR 0196_GICAR_MAN_EXP_V1.2
Entrada en servei Manual d’instal·lació Assumpte_MAN_INS_Vx.y Versió MRR 0196_GICAR_MAN_INS_V1.2
Entrada en servei Manual d’usuari Assumpte_MAN_USU_Vx.y Versió MRR Assumpte_CHK_NomEstandard_Vx.y 0196_GICAR_MAN_USU_V1.2
Entrada en servei Informe de revisió (de lliurables) Assumpte_IN_REV_Vx.y 0196_GICAR_IN_REV_V1.1
Seguiment i control Informe executiu de qualitat 0196_GICAR_IN_QUAL_V1.1
Seguiment i control Criteris d’acceptació de les històries d’usuari Assumpte_DT_CRI_ACC_Vx.y 0196_GICAR_DT_CRI_ACC_V1.1
Seguiment i control Pla de formació Assumpte_PLA_FOR_Vx.y 0196_GICAR_PLA_FOR_V1.1
Seguiment i control Pla de gestió del canvi Assumpte_PLA_GC_Vx.y 0196_GICAR_PLA_PGC_V1.2
Seguiment i control Notes de versió Assumpte_IN_NVE_V1.0 0196_GICAR_IN_NVE_V1.2
Seguiment i control Acta d’acceptació de la solució Assumpte_AC_ACC_Vx.y 0196_GICAR_AC_ACC_V1.2
Seguiment i control Acta (de reunió) Assumpte_AC_aaaammdd_Vx.y P140005_GICAR_AC_20150317_V1.2
Seguiment i control Formulari de sol·licitud per incorporar servei mòbil a gencat Accés a la web d’atenció ciutadana
Seguiment i control Informe d’Avaluació de Preparació Agile Assumpte_INF_AGILE_PREP_V1.0_Vx.y Versió MRR Assumpte_CHK_AGILE_PREP_V1.0x_Vx.y P140005_GICAR_INF_AGILE_PREP_V1.2
Seguiment i control Checklist d’avaluació de maduresa en Scrum Assumpte_CHK_AGILE_SCRUM_Vx.y P140005_GICAR_CHK_AGILE_SCRUM_V1.2

ANNEX B (normatiu) Nomenclatura i estructura dels lliurables de proves

Nomenclatura i estructura a l’eina de repositori de gestió de les proves

  1. Els noms de les releases han de seguir l’estàndard de nomenclatura de versions

– Per projectes waterfall: 1.0.0.B001 (El nom inclou el cicle)

– Per projectes Agile: 1.0.0

  1. El nom de cada carpeta ha de ser concís, format per paraules separades per espais on la primera lletra de cada paraula estigui amb majúscula. Ha de ser de menys de 80 caràcters i evitar preposicions i articles.

  2. El nom de les carpetes que estructuren els requisits haurien de ser dividits en Requisits Funcionals i Requisits No Funcionals

  3. Les carpetes i els seus nivells han der ser classificats de forma coherent i facilitar la seva comprensió i accés.

    Per exemple, en el cas dels Requisits Funcionals dividint per mòduls, i en el dels Requisits No Funcionals establint nivells segons les característiques de qualitat, exceptuant la característica ‘Funcionalitat’ que ja està representada en l’anterior grup (‘Requisits Funcionals).

    oct

    En el cas de les proves es pot usar la següent proposta:

    oct_test

ANNEX C (normatiu) Estructura jeràrquica dels lliurables

Estructura de carpetes

Bloc Inclou
1-Gestió Per a cada projecte vinculat a una solució s’ha de crear una subclassificació (subcarpeta) amb Codi projecte - Nom projecte on s’han d’ubicar tots els lliurables d’aquest projecte: Acta de reunió, Pla de qualitat, Presentació de Kickoff, Visió i Necessitats
2-Anàlisi Document de Visió i Necessitats i l’Especificació de Requisits
3-Disseny Descripció d’Arquitectura i Disseny(s) Detallat(s)
4-Construcció En aquest espai no s’ha d’ubicar el codi font, sinó aspectes de documentació i la url al SIC on està dipositat el codi font.
5-Proves i revisions Tots els lliurables relacionats amb proves i revisions (Pla Mestre de Proves, Especificació de proves, Informe de resultats de proves, Informe de revisió de qualitat, Pla de millora de qualitat, …)
6-Operació i suport Manual d’Instal·lació, Manual d’Explotació, Manual d’Usuari, Pla de Formació, Pla de gestió del canvi, Informe de notes de versió, Acta d’acceptació
7-Referències Documentació externa que no ha estat generada directament pel projecte o solució, com informes externs (Gartner, benchmarkings, estudis, …)

Part 1: Abast

Aquest document especifica els requisits de nomenclatura dels diferents productes tècnics de treball en un desenvolupament de SI.

Part 2: Referències

Nomenclatura de documents electrònics

Part 3: Termes i definicions

No s’han definit termes específics en aquest estàndard.

Part 4: Format, ubicació i abast dels lliuraments

  1. Els diferents lliurables han de ser proporcionats en el format que defineixi el CTTI (documents electrònics i/o informació dipositada en les eines homologades).
  2. Tot lliurable ha de tenir un format que permeti la seva edició. No s’acceptaran, per exemple, documents en format PDF.
  3. En qualsevol dels formats el seu contingut ha d’estar en català. En el cas del codi això aplica únicament als comentaris.
  4. S’ha de produir i mantenir la documentació mínima per la correcta execució dels serveis, així com les seves modificacions
  5. Els lliurables han de ser ubicats o dipositats en l’eina que determini el CTTI.
  6. S’ha de mantenir un registre del detall de les versions, dates i destinataris dels lliuraments.
  7. El CTTI és el propietari de tots els lliurables elaborats pels diferents proveïdors en els serveis prestats
  8. El proveïdor de cada lliurable ha de mantenir un registre dels lliurables enviats al CTTI amb el detall de les versions, dates i destinataris

Part 5: Revisió i acceptació

  1. Una vegada l’adjudicatari notifiqui als responsables del CTTI/Àmbit de que un lliurable ha estat completat i disponible per la seva revisió, aquests han de disposar d’un màxim de dies laborables acordats per efectuar la revisió i donar una resposta a l’adjudicatari (per defecte 10 dies laborables)
  2. Qualsevol discrepància o disconformitat greu ha de ser notificada tan aviat com sigui detectada.
  3. Si no s’ha donat resposta durant el període definit a l’apartat anterior el lliurable serà considerat com a aprovat.
  4. Si s’han detectat disconformitats l’adjudicatari haurà de resoldre-les en el temps màxim que s’hagi acordat per les dues parts (per defecte 2 dies laborables). El CTTI/Àmbit tindrà en aquest cas un màxim de dies laborables acordats per donar resposta (per defecte 5 dies laborables)
  5. La no conformitat amb els lliurables rebuts (per incompliment amb els requisits definits, els estàndards o els criteris de qualitat), podrà provocar la paralització de la facturació fins a la resolució de les disconformitats detectades.
  6. S’haurien d’aplicar penalitzacions per aquells lliurables que hagin estat rebutjats en més de 2 ocasions

Part 6: Nomenclatura dels lliurables

  1. Els documents electrònics generats per una solució, sigui quina sigui la seva tipologia, han de seguir la norma de Nomenclatura de fitxers establerta a ANNEX A (normatiu) Nomenclatura dels documents tècnics

  2. Si el document està referit a un codi de projecte o solució, aquest s’ha d’usar com a prefix del document. Exemple: 0196_GICAR

  3. Si el document està referit a una petició, s’hauria d’incloure el seu codi. Per exemple, en el cas d’una oferta, afegir el codi de comanda de remedy (després de l’acrònim de l’aplicació).

  4. Els lliurables de proves han de seguir la nomenclatura especificada a l’annex ANNEX B (normatiu) Nomenclatura i estructura dels lliurables de proves

Part 7: Estructura dels lliurables

  1. En cas que els lliurables siguin dipositats en una eina o repositori cal que segueixin l’estructura indicada a l’ANNEX C (normatiu) Estructura jeràrquica dels lliurables

  2. Els lliurables que quedin obsolets s’hauran d’ubicar en un espai/carpeta anomenada Arxivat en la carpeta corresponent a l’àmbit al que aplica (1-Anàlisi, 2-Disseny, …)

ANNEX D Projectes finançats amb fons MRR

Els projectes finançats amb fons MRR obliguen al compliment de requisits de comunicació i visibilitat que són jurídicament vinculants. Incomplir aquestes obligacions pot comportar un procediment de reintegrament. Per això, s’ha de seguir el marc normatiu que regula les obligacions de comunicació dels fons Next Generation EU:

– El Reglament del Parlament Europeu i del Consell.

– L’acord de finançament entre la Comissió Europea i l’Estat espanyol.

– El Pla de recuperació, transformació i resiliència.

Per aquest motiu l’Oficina de Qualitat ha generat versions específiques de les plantilles dels lliurables que inclouen logos específics per tal de poder donar compliment als requisits de comunicació i visibilitat pels fons MRR. Les podreu trobar a l’apartat de “Lliurables”.

Referències:

– Fons europeus a Catalunya

– Manual bàsic d’identificació visual corporativa

Lliurable Nomenclatura Exemple
Oferta de proveïdor Assumpte_OFE_PRO_Vx.y ID00056_GICAR_OFE_PRO_V1.0
Pla de qualitat 0196_GICAR_PLA_QUAL_V1.2, 0196_GICAR_PLA_QUAL_AGILE_V1.2
Especificació de requisits (Anàlisi funcional) Assumpte_DT_ERQ_Vx.y 0196_GICAR_DT_ERQ_V1.0
Pla mestre de proves Assumpte_PLA_PMP_Vx.y 0196_GICAR_PLA_PMP_V1.0
Informe d’anàlisi del codi font Assumpte_IN_REV_CF_Vx.y 0196_GICAR_IN_CF_V1.2
Disseny tècnic detallat Assumpte_DT_DTE_Vx.y 0196_GICAR_DT_DTE_V1.0
Informe de resultat de proves Assumpte_IN_RPt_Vx.y, On t pot variar segons el tipus de resultat de proves 0196_GICAR_IN_RPI_V1.2, 0196_GICAR_IN_RPQR_V1.3, 0196_GICAR_IN_RPQF_V1.2, 0196_GICAR_IN_RPA_V1.2
Informe de defectes Assumpte_IN_DEF_Vx.y 0196_GICAR_IN_DEF_V1.2
Pla de millores de qualitat Assumpte_PLA_MIL_Vx.y 0196_GICAR_PLA_MIL_V1.2
Manual d’explotació Assumpte_MAN_EXP_Vx.y 0196_GICAR_MAN_EXP_V1.2
Manual d’instal·lació Assumpte_MAN_INS_Vx.y 0196_GICAR_MAN_INS_V1.2
Manual d’usuari Assumpte_MAN_USU_Vx.y 0196_GICAR_MAN_USU_V1.2
Informe d’Avaluació de Preparació Agile Assumpte_INF_AGILE_PREP_V1.0_Vx.y P140005_GICAR_INF_AGILE_PREP_V1.2