Guia de Referència Tècnica: Documentació, Distribució i Proves (UT 6, 7 i 8)¶
UT 6: Documentació d'Aplicacions i Sistemes d'Ajuda¶
Tipologia de Manuals i Destinataris¶
| Tipus de Manual | Objectiu Principal | Perfil de l'Usuari |
| Manual d'Usuari | Guia detallada sobre les funcions, activitats i respostes a missatges d'error de l'aplicació. | Usuari final |
| Guia de Referència | Descripció exhaustiva de paràmetres, configuracions i informes d'error per a consultes precises. | Usuaris avançats |
| Guia Ràpida | Document breu (1-2 pàgines) amb passos visuals per a una posada en marxa immediata. | Usuaris nous |
| Manual d'Instal·lació | Instruccions de desplegament, requisits de sistema, normes de seguretat i resolució de problemes comuns. | Tècnics d'implantació |
| Manual de Configuració | Detall de variables d'entorn, fitxers de paràmetres i impacte dels ajustos en el comportament. | Administradors / Tècnics |
| Manual d'Administració | Gestió de permisos, còpies de seguretat, monitoratge i manteniment del sistema en producció. | Administradors de sistemes |
Formats de Fitxers d'Ajuda¶
- CHM (Compiled HTML Help): Successor oficial del format WinHelp basat en HTML. Compila l'índex, la taula de continguts i el cercador en un únic fitxer.
- HTML/Web: Documentació moderna accessible via navegador; és el format estàndard per a actualitzacions centralitzades i contingut dinàmic.
- PDF: Format universal i portable que garanteix la fidelitat visual; prioritari per a manuals formals i impressió.
- Markdown: Format de text lleuger, ideal per a documentació col·laborativa (README, wikis) i fluxos de treball Docs as Code.
Ajuda Genèrica vs. Sensible al Context¶
L'ajuda genèrica ofereix un repositori global de coneixement (PDF, wikis) on l'usuari ha de cercar la informació. En contrast, l'ajuda sensible al context detecta l'element actiu —finestra, botó o camp— per mostrar informació específica. Tècnicament, s'implementa mitjançant la vinculació de IDs de context a propietats del component com HelpContext.
Exemples moderns d'ajuda contextual:
- Tooltips intel·ligents que apareixen en passar el cursor per controls.
- Panells d'ajuda integrats en IDEs que s'actualitzen segons la línia de codi activa.
- Missatges d'assistència i validació en temps real dins de formularis complexos.
Eines de Generació i Captura¶
- Eines de Generació:
- GitBook: Plataforma moderna per a documentació col·laborativa amb suport per a Markdown i versionat.
- MadCap Flare: Solució professional que permet el Single-sourcing (reutilització de contingut) per publicar en múltiples formats des d'una única font.
- HelpMaker: Eina de caràcter "legacy", actualment poc mantinguda i amb un ús cada vegada més minoritari.
- Eines de Captura:
- ShareX: Programari de codi obert per a Windows, considerat el successor espiritual de ZScreen.
- Greenshot: Eina de codi obert lleugera amb integració a l'ecosistema Office.
- Lightshot: Utilitat multiplataforma per a captures ràpides i selecció d'àrees amb dos clics.
UT 7: Empaquetat i Distribució de Programari¶
Components Essencials d'un Paquet (Bundle)¶
- Executables: Programes principals, mòduls compilats i scripts d'arrencada.
- Biblioteques: Dependències externes (DLL, .so, .dylib) necessàries per a l'execució.
- Recursos: Elements multimèdia, icones, fonts i fitxers de traduccions (i18n).
- Fitxers de configuració: Paràmetres per defecte i definicions de l'entorn (.json, .yaml, .xml).
- Metadades/Manifest: Informació de versió, llicències i dependències (ex:
package.json,pom.xml). - Scripts d'instal·lació: Procediments per registrar serveis, crear directoris i configurar permisos.
Eines i Formats d'Instal·lació per a Windows¶
- IExpress 2.0: Utilitat nativa per a paquets autoextractibles que utilitza fitxers SED (Self Extraction Directive).
- Inno Setup: Eina de codi obert que utilitza scripts Pascal per a instal·ladors personalitzables.
- NSIS: Sistema lleuger i flexible basat en scripts propis de Nullsoft.
- WiX Toolset: Motor basat en XML per generar paquets MSI, integrat en pipelines de CI/CD.
- Advanced Installer: Solució comercial amb interfície gràfica per a formats MSI i MSIX.
- MSIX: Format modern i recomanat per Microsoft per a Windows 10 i 11.
Estandardització en Linux¶
| Format de Paquet | Tipus | Eina de Gestió Associada |
| DEB | Tradicional (Debian/Ubuntu) | apt / dpkg |
| RPM | Tradicional (Red Hat/SUSE) | dnf / rpm / **zypper** |
| Snap | Universal (Canonical) | snap |
| Flatpak | Universal (Comunitat) | flatpak |
| AppImage | Universal (Portable) | Execució directa (no requereix privilegis d'administrador) |
Signatura Digital i Autenticitat¶
El marc normatiu ha evolucionat cap al reglament eIDAS 2.0 (2024), introduint la Identitat Digital Europea (EUDI Wallet). Els estàndards principals són:
- CAdES: Signatures per a transaccions electròniques basades en CMS.
- XAdES: Extensions XML per a signatures avançades; és l'estàndard habitual a l'administració pública espanyola.
- PAdES: Signatures avançades integrades específicament en documents PDF.
Per a la gestió a l'Estat Espanyol s'utilitza AutoFirma (escriptori) i el servei web VALIDe, que ha substituït solucions anteriors com @Firma. En l'àmbit comercial, les plataformes líders són DocuSign i Adobe Acrobat Sign.
UT 8: Qualitat i Realització de Proves de Programari¶
Fonaments i el Cicle STLC¶
L'objectiu de les proves és descobrir errors no detectats per garantir el compliment dels requisits. El cicle STLC (Software Testing Life Cycle) es divideix en:
- Anàlisi: Revisió de requisits testables i identificació dels criteris d'acceptació.
- Planificació: Definició de l'estratègia, recursos i selecció d'eines.
- Execució: Llançament dels casos de prova, registre de resultats i reporte de defectes.
- Tancament: Anàlisi de mètriques de cobertura i elaboració de l'informe final.
Estratègies de Disseny de Proves¶
- Caixa Negra (Funcional): Es basa en entrades i sortides segons requisits, ignorant l'estructura interna.
- Caixa Blanca (Estructural): Examina la lògica interna, fluxos de control i condicions del codi font.
- Estratègia Incremental: Construcció i prova del sistema per mòduls per aïllar errors progressivament.
Metodologies de Proves d'Integració¶
- Ascendent: Prova primer els mòduls de baix nivell, utilitzant Drivers per simular les capes superiors.
- Descendent: Comença pel mòdul principal i requereix Stubs per simular mòduls no desenvolupats.
- Big Bang: Integració simultània de tots els components; aquesta estratègia dificulta enormement la localització d'errors.
- Sandvitx: Estratègia híbrida que combina els enfocaments ascendent i descendent.
Tipologia de Proves de Sistema¶
- Configuració: Verifica el funcionament en diferents SO, navegadors i maquinari.
- Recuperació: Avalua la capacitat de restauració i mesura el temps de recuperació i la integritat de les dades.
- Ús de Recursos: Monitoritza el consum de CPU, memòria i xarxa sota càrrega.
- Seguretat: Valida la protecció de dades i la resiliència davant atacs de denegació de servei (DoS).
Frameworks per Ecosistema¶
- Java: JUnit 5 (Jupiter), que permet missatges d'error descriptius i suport natiu per a lambdes.
- JavaScript:
- Jest: Destaca pel seu model "Zero Config" i les proves d'instantània (Snapshot).
- Mocha: Framework flexible i configurable.
- Cypress: Específic per a proves End-to-End (E2E) al navegador.
- PHP: PHPUnit, basat en l'arquitectura xUnit.
- .NET: NUnit, amb suport per a execució en paral·lel i integració amb Azure DevOps.