Classificació de l'estàndard
Codi de l'estàndard
Versió	1.0
Data última actualització	17/01/2017
Responsable	Àrea de Solucions
Llicència	Aquesta obra està subjecta a una llicència de Reconeixement-NoComercial-CompartirIgual 4.0 Internacional de Creative Commons

Part 1: Abast

Aquest document especifica els requisits mínims i mètodes que han d’aplicar-se en el desenvolupament d’estàndards al CTTI

Part 2: Referències

Els següents documents són referenciats en el text de forma que tot o part del seu contingut forma part dels requisits d’aquest document:

Part 3: Termes i definicions

Pel propòsit d’aquest document, s’apliquen els següents termes i definicions:

Estàndard

Document que estableix els requisits, especificacions, guies o característiques que poden ser usats de forma consistent per assegurar que els productes, processos i serveis s’adeqüen al seu propòsit. “Una forma acordada de com fer les coses”.

Clàusules i subclàusules

Són els components bàsics que permeten dividir el contingut del document. Una clàusula pot contenir vàries subclàusules.

Requisit

Expressió que estableix un criteri que s’ha de’assolir i en la que no es permet cap desviació.

Recomanació

Expressió que estableix que entre diferents possibilitats hi ha una de recomanada

Mètode de prova o verificació

Element que especifica el procediment per determinar els valors de les característiques que es referencien en els estàndards (mesures, indicadors, …) o comprovar la conformitat amb els requisits establerts.

Part 4: Requisits generals

Objectius dels estàndards

L’objectiu dels estàndards és establir un acord de com fer les coses. Per aquest motiu, els documents han de:

ser complets en els límits definits pel seu abast
ser consistents, clars, succints i acurats
ser comprensibles per l’usuari que els ha de llegir i aplicar, evitant al màxim l’ús de jerga tècnica

Enfoc basat en el rendiment

Els requisits han de ser expressats, si és possible, en termes del seu rendiment i no tant en termes del seu disseny o descriptius.

Això permet una major llibertat en el desenvolupament tecnològic i redueix el risc d’impactes no desitjats per canvis en el mercat o estàndards reconeguts Exemple: “Un mètode de codi ha de ser construït de forma que sigui fàcil de mantenir” (expressat en termes de rendiment) versus “Un mètode de codi ha de tenir un màxim de 40 línies” (requisit de disseny)

Enfoc basat en la verificabilitat

Independentment de l’objectiu de l’estàndard, tot requisit inclòs ha de poder ser verificat. S’ha d’evitar l’ús de paraules del tipus “suficientment”, “aproximadament”, …

Enfoc basat en la utilitat

No s’han de descriure o estandarditzar totes les característiques d’un aspecte. S’han de considerar aquelles que realment són necessàries i prioritàries.

Part 5: Estructura dels estàndards

Subdivisió en documents

Per cada subjecte o tema a estandarditzar ha d’existir un únic document, excepte si el document és molt voluminós.

Exemple: Estàndard de protecció d’entorns. Ha d’existir un sol document amb seccions o annexos per representar diferències en l’aplicació de l’estàndard per diferents tipus d’entorns (Oracle, …).

Subdivisió en parts

Els diferents aspectes a tractar s’han de separar en parts.

Exemple: “Part 2: Requisits pels entorns de preproducció”
Si existeixen elements que van adreçats a diferents grups d’interès (proveïdor de desenvolupament, usuari, …), separar en parts del document o en annexos

Exemple: “Part 3: Requisits d’accés per part dels usuaris”, “Part 4: Requisits d’administració”
Tot estàndard ha de contenir les següents parts:
- Part 1: Abast. Usar el subjecte “aquest document” i una de les formes verbals: “especifica…”, “estableix …”, “dóna guies per…”, “defineix termes…”
- Part 2: Referències
- Part 3: Termes i definicions
- Part _: Títol (N parts per estructurar l’estàndard segons clàusules)
- Part _: Mètodes de prova
- Part _: ANNEXOS

Subdivisió en clàusules

Els elements (prescriptius, recomanacions, ..) han de ser descrits en clàusules numerades i subclàusules
Els elements han de ser descrits en la forma verbal adequada, seguint l’annex ANNEX A (Normatiu) Formes verbals per l’expressió de les clàusules
Els elements obligatoris han de ser especificats abans que els recomanats.
Si hi ha varis elements recomanats s’ha d’incloure el subtítol ‘Recomanacions’ com a separador, abans de les recomanacions
Els elements han de ser descrits en veu activa Exemple: “El codi font ha de ser lliurat en el repositori …” enlloc de “S’ha de lliurar el codi font en el repositori…”
S’ha de presentar una única idea per sentència (un requisit, una recomanació, …)

Subdivisió en annexos

Els annexos han de ser usats únicament per donar descripcions complementàries al text ja descrit en l’estàndard.
Cada annex ha de ser descrit amb:
- Prefix ‘ANNEX’ i una lletra consecutiva (començant per la ‘A’), a continuació seguit de:
- “(normatiu)” o “(informatiu)”, segons si complementa clàusules de tipus requisit o si conté elements informatius, i finalment:
- El títol
Exemple: “ANNEX A (normatiu) Formes verbals per l’expressió de les clàusules
Els annexos poden ser descrits internament amb clàusules i subclàusules

Part 6: Mètodes de prova o verificació

Els mètodes de prova s’han d’identificar en l’annex ‘Mètodes de prova’. En els requisits s’ha d’establir referències als mètodes de prova que els verifiquen.

Part 7: Esborrany

L’estàndard en format esborrany ha de seguir la plantilla [PLANTILLA DE ESTÀNDARDS]()

ANNEX A (normatiu) Formes verbals per l’expressió de les clàusules

REQUISITS. Les formes verbals mostrades a continuació han de ser usades per indicar requisits que han de ser estrictament seguits per donar conformitat a l’estàndard i on no es permeten desviacions

Forma verbal	Expressions excepcionals (només usar per raons lingüístiques)
ha de	es requereix, és necessari
no ha de	no es permet, no es pot

RECOMANACIONS. Les formes verbals mostrades a continuació han de ser usades per indicar que entre diferents possibilitats hi ha una que es recomana, sense excloure la resta

Forma verbal	Expressions excepcionals (només usar per raons lingüístiques)
hauria de	es recomana que
no hauria de	no es recomana que

PERMIS. Les formes verbals mostrades a continuació han de ser usades per indicar un curs d’acció permès dins els límits del document (per exemple dins un requisit)

Forma verbal	Expressions excepcionals (només usar per raons lingüístiques)
pot	es permet
no necessita	no es requereix que

ANNEX B (informatiu) Exemple d’estructura final d’un estàndard

Estàndard per l'estructura i contingut dels estàndards