Vés al contingut (premeu Retorn)

Menús d'un servei

Estructura de la informació dels serveis

Menús d'un servei

Tots els serveis tenen la mateixa estructura. Quan es crea un servei es crea també una estructura que consta de 5 carpetes

  1. El servei
  2. Documentació
  3. FAQ
  4. Doc tècnica
  5. Suggeriments

Aquesta estructura es manté en tots els servis, si un servei no te contingut en algun d'aquests apartats es treu de la navegació. Dins de cada apartat es poden crear subcarpetes. 

Guia d'estil

La documentació ha de ser clara i concisa (menys rotllo és més qualitat per l'usuari).

La terminologia és tancada i el màxim de reduïda.

Sempre s'utilitzarà la mateixa paraula per un mateix concepte.

Utilitzar exactament els mateixos termes que a les aplicacions.

Si una paraula preveiem que no s'entendrà cal explicar-la a la FAQ i enllaçar-la allà cada vegada que la utilitzem.

Cal explicar tots els conceptes abans d’utilitzar-los.

Cal maximitzar l’ús dels enllaços amb les següents funcions:

- Enllaçar amb les aplicacions web

- Enllaçar amb d'altres apartats relacionats

Els enllaços han de contenir el text del que representen. Mai enllaçar amb paraules de l'estil "clica aquí", "aquí".

1. El servei

Conté 4 subapartats

1. Descripció del servei:

Explicar el servei ha de contenir els apartats

    • Què és
    • Objectius
    • Característiques: com està desenvolupat; per què serveix

2. Normativa

La normativa ha d'especificar

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

3. Procediments

Defineix els procediments per:

    • Com s'utilitza el servei
    • Procediments per obtenir el servei i per utilitzar-lo; com demanar el servei, com fer una alta; com fer una baixa; com demanar més capacitat ... Aquests procediments els defineix la direcció TIC conjuntament amb els responsables funcionals i tecnològics.

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

Cal fer un subtítol per a un SOL procediment!

4. Model econòmic i tarifes

Si escau, la descripció del model econòmic del servei i les seves tarifes

5. Evolució del servei

Explicació de les novetats funcionals i millores del servei que incorpora cada una de les versions, Tots els serveis han de tenir versió del servei que no te relació amb la versió del software que l'implementi; cada nova versió o subversió ha d'explicar que aporta, que modifica de la versió anterior, que millora ... Cada nova versió ha de tenir

  • Títol de la versió i data:  Versió v1.2b (18/10/2016)
  • Millores funcionals
  • Millores tecnològiques

2. Documentació

Documentació del servei; conté els diferents manuals del servei i els casus d'ús

  • Manual per a l'usuari
  • Manual per l'administrador
  • Manual per l'editor
Cada manual té un usuari final definit. Hi ha d'explicar totes les funcionalitats i per cada funcionalitat una enumeració de quins són els passos a fer. Enllaçats amb les FAQ relacionades.

3. FAQ 

Les preguntes més frequents del servei, una pàgina per a cada FAQ. El tipus de visualització: vista resum

Cada pregunta de la FAQ ha de tenir una sola resposta (no pot preguntar dues o més coses).

Si un text es repeteix diverses vegades, fer una FAQ per respondre aquesta i enllaçar-ho.

Quan poseses un enllaç a una FAQ cal posar com a text tota la pregunta.

4. Doc tècnica

Apartat amb tota la documentació tècnica

    • 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

5. Suggeriments 

Una carpeta tipus comentaris, on els usuaris un cop identificats poden deixar els seus suggeriment