Vés al contingut (premeu Retorn)

Sou a: Inici / Portal de Serveis TIC / Documentació / Guia d'estil

Guia d'estil

Guia d’estil del portal dels Serveis TIC de la UPC

Serveis TIC és un portal dirigit als usuaris i futurs usuaris dels serveis TIC de la UPC.

Aquesta guia d’estil s’estructura en 3 apartats segons la finalitat:

  1. Descobrir nous serveis TIC de la UPC.
  2. Conèixer l’estat dels serveis TIC.
  3. Ajudar als usuaris de serveis TIC a realitzar les seves tasques.

Per a més informació pots consultar la guia d'estil de softcatala

Estils a seguir per tot el portal

  • Construeix frases curtes escrites de forma directa. Dirigeix-te a l’usuari en segona persona de l’imperatiu o del present.
    • Sí: Accedeix a totes les funcionalitats via web.
    • No: Tens al teu abast totes les funcionalitats del servei a través d’una interfície web.
    • No: Teniu al vostre abast totes les funcionalitats del servesi a través d’una interfície web.
    • Sí: Contracta serveis complementaris
    • No: Pots contractar els següents serveis complementaris
    • No: Es poden contractar els següents serveis complementaris
  • Quan ens referim al servei, ens dirigirem també de forma directa parlant amb la tercera persona del present:
    • Sí: El servei rep les notificacions que li envies
    • No: Rebem les teves notificacions
    • No: El servei rep les notificacions que els usuaris li envien
    • No: El servei hauria de rebre
  • Utilitza un llenguatge clar i concís. Utilitza una terminologia tancada i el màxim de reduïda. Utilitza sempre la mateixa paraula per un mateix concepte clau. No utilitzis sinònims. Si tens diverses paraules per dir un concepte escull-ne només una.
    • Sí: Connecta’t a la wifi perquè la wifi no té límits.
    • No: Connecta’t a la wifi perquè la xarxa sense fils no té límits.
  • Utilitza exactament els mateixos termes que a les aplicacions. Si l’aplicació utilitza els termes “Consulta el perfil d’usuari”:
    • Sí: Consulta el perfil d’usuari
    • No: Entra a la informació d’usuari
  • Explica la terminologia que l’usuari desconeix a les FAQ.
    • Sí: No pots utilitzar el <a>hover</a> perquè estàs utilitzant una tablet i no permet el <a>hover</a>. (els dos enllaços porten a la FAQ on s’explica què és hover)
    • No: No pots utilitzar el hover perquè estàs utilitzant una tablet i no permet el hover.
  • Utilitza el màxim d’enllaços cap a les aplicacions web
    • SÍ: Accedeix a <a>Obre</a>. (l’enllaç porta a la pàgina de l’aplicació web que obre un document)
    • NO: Selecciona el botó Obre.
  • Utilitza el màxim d’enllaços cap a apartats relacionats
    • SÍ: connecta’t per <a>NFS</a> a aquesta aplicació. (l’enllaç porta a les FAQ)
    • NO: connecta’t per NFS a aquesta aplicació
  • Utilitza textos representatius pels enllaços
    • SÍ: <a>Com puc trobar serveis TIC?</a>
    • NO: Per a saber com puc trobar serveis TIC <a>Clica aquí</a>
    • NO: <a>Aquí</a> trobaràs la resposta a saber com puc trobar els serveis TIC
  • Utilitza l’imperatiu per botons i enllaços
    • SI: Envia
    • NO: Envieu
    • NO: Cal enviar

 

Pàgines de descobriment de nous Serveis TIC de la UPC

Les pàgines de descobriment dels nous serveis són:

Pàgina inical

******************imprescindible per publicar****************

RESPON A LA PREGUNTA: Quin és el benefici per l'usuari d'utilitzar el servei

Emplena la descripció del servei amb la proposta de valor del servei.

Explica-hi per quina raó ha d’utilitzar el servei l’usuari. Utilitza la següents fórmules de redacció:

-          Acció (imperatiu, segona persona del singular) + objecte + [qualitat/avantatge]

“Rep i envia missatges de correu electrònic des de qualsevol lloc” “Llegeix llibres amb el mòbil” “Obre, edita i crea documents en línia”

Pàgines del servei

L’apartat “servei” descriu el servei des de diversos punts de vista. Conté els apartats:

-          Pàgina de presentació del servei

-          Pàgina de descripció del servei

-          Normativa

-          Procediments

-          Model econòmic i tarifes

-          Evolució del servei

Tingues en compte quan redactis aquests apartats:

  • Redacta els continguts en 2a persona del present quan t’adrecis a l’usuari.
  • Parla del servei en present.
  • Empra llenguatge planer.
  • Explica els termes complicats a la FAQ i enllaça’ls des d’aquesta pàgina.

Pàgina de presentació del servei

******************imprescindible per publicar****************

La pàgina del servei descriu en què consisteix el servei.[JGD1] 

Parla-hi de:

-          Què és el servei?

-          Quin és el valor que aporta a l’usuari?

-          Què pot fer l’usuari amb aquest servei?

Segueix el següent esquema per redactar aquesta pàgina:

-          El servei/nom del servei és [què és].

  • SI: El servei cloudUPC és la solució segura d’infraestructura virtual de servidors, routers i disc.
  • NO: El servei cloudUPC permet disposar d'una infraestructura virtual de servidors, routers i disc.

-          Llistat de propostes de valor format per [una característica] + valor que aporta a l’usuari escrit en 2a persona de l’imperatiu.

  • SI: El servei opera en modalitat d’autoservei: Gestiona el teu servei en qualsevol moment i resposta immediata
  • NO: El servei opera en modalitat d'autoservei: l'alta al servei i l'operació dels servidors, routers i disc virtual és autogestionada.
  • SI: Munta el CPD virtual en un temps mínim i sense inversions inicials.
  • NO: cloudUPC permet muntar CPD's virtuals en un temps mínim i sense inversions inicials.
  • SI: Adapta els recursos de processament de dades a les teves necessitats, en un temps mínim i sense necessitat de grans inversions inicials.
  • NO: D'aquesta manera les unitats poden adaptar els recursos de processament de dades a les seves necessitats, en un temps mínim i sense necessitat de grans inversions inicials.

Pàgina de descripció del servei

******************imprescindible per publicar****************

Aquest apartat descriu a l’usuari el model de funcionament del servei i les seves

funcionalitats. ATENCIÓ: No el confonguis amb el manual d’usuari.

Parla-hi de:

  • Com s’usa el servei (portal web, mòbil, telèfon...)
  • Els rols que pot prendre l’usuari
  • Les funcionalitats disponibles

Normativa

******************imprescindible per publicar  (si existeix)****************

L’apartat de normativa descriu clarament les normes d’ús del servei.

Parla-hi de:

  • Qui pot utilitzar el servei
  • Normes d'ús per els usuaris del servei
  • Normes d'ús per als administradors del servei i els responsables funcionals (A definir per la direcció TIC).

Procediments

******************imprescindible per publicar (si existeix)****************

Aquest apartat descriu tots els procediments relacionats amb el servei: Alta, baixa, modificació.

Redacta en un apartat diferent cada procediment. A cada partat parla-hi de:

  • Com es realitza
  • Per quin canal
  • A qui va drigit

Els procediments han d’estar validats per la direcció TIC i els responsables funcionals i tecnològics.

En alguns serveis la Normativa i els procediments s'ajunten en un apartat Normativa i procediments.

Model econòmic i tarifes

Parla en aquest apartat de:

  • Model econòmic que segueix el servei
  • Les tarifes associades

Evolució del servei

******************imprescindible per publicar****************

Cada servei evoluciona en versions. Aquestes versions són independents de les versions del software que implementi (si és que són diferents).

Descriu cada versió amb:

  • El títol: DATA – Actualització del “servei XXXX” a versió 1.1
  • I un llistat de canvis o noves funcionalitats que s’hagin realitzat. Parlant des del valor a l’usuari:
  • SI: Els teus missatges arribaran abans al seu destinatari. Hem afegit un quart <a>FE</a> que incrementa un 33% la capacitat de resposta del sistema.
  • NO: S'ha afegit un quart FE que incrementa en un 33% la capacitat de donar resposta a peticions web de lectura i enviament de missatges via la interfície Horde.

Deixa clara quina és la versió actual.

I afegeix al final quines funcionalitats es preveuen incorporar en un futur.

Pàgines per conèixer l’estat dels serveis

Notificacions

L’apartat de notificacions es mostra a la pàgina principal. Inclou aquelles notificacions rellevants pels usuaris.

Redacta les notificacions curtes i que les entengui l’usuari.

Parla del valor que aporta a l’usuari.

Utilitza paraules planeres.

Problemes

L’apartat de problemes es mostra a la pàgina principal. Inclou aquells problemes que afecten l’ús del servei per part dels usuaris.

Redacta el títol en forma directa.

Parla-hi de:

  • Amb què afecta l’usuari (no pot utilitzar el servei, una part del servei...).
  • Quan tornarà a tenir el servei restablert.
  • Solució prevista (si és que hi és)
  • Per quins canals se’l notificarà.

Indicadors

Redacta els indicadors tenint en compta que:

  • Siguin autoexplicatius
  • Temporalitat
  • Continguin les unitats en les que es valora

Pàgines per ajudar als usuaris de serveis TIC a realitzar les seves tasques

Tots aquests apartats són consultats pels usuaris mentre estan utilitzant el servei. Per tant volen una resposta ràpida al seu problema.

Els donarem la resposta ràpida redactant tots els apartats utilitzant:

  • Frases curtes
  • Enumeracions dels passos a seguir
  • Enllaços amb les FAQ
  • Enllaços amb l’aplicació
  • Imatges
  • Vídeos explicatius

Documentació

La documentació  conté informació de nivell funcional per tal que l'usuari entengui el perquè el servei funciona d'una certa manera. Redacta un manual per cada tipus d’usuari:

  • Manual per a l'usuari
  • Manual per l'administrador
  • Manual per l'editor

FAQ 

******************imprescindible per publicar****************

Les FAQ expliquen com realitzar les diferents tasques del servei.

Formula cada pregunta amb un sol concepte. La resposta ha de ser única.

Sigues concís amb la resposta. Escriu-la amb enumeració de passos utilitzant la negreta i els enllaços.

Si un text es repeteix diverses vegades, fes una FAQ per respondre aquesta pregunta i i enllaça-ho allà on hi facis referència.

Posa com a text dels enllaços el títol complert de la secció a la que fa referència.

  • SÍ: <a>Com puc trobar serveis TIC?</a>
  • NO: Per a saber com puc trobar serveis TIC <a>Clica aquí</a>
  • NO: <a>Aquí</a> trobaràs la resposta a saber com puc trobar els serveis TIC

Doc tècnica

Apartat apartat conté la documentació tècnica. Els tecnicismes redirigeix-los a les FAQ.

  • Fitxa tècnica: Una fitxa amb la informació tècnica de l'aplicació o aplicacions que formen el servei,
    • arquitectura del sistema d'informació
    • tecnologia emprada
    • esquema tecnològic
    • ...
    • Documentació de referència: si escau
    • Enllaços: si escau