Skip to content

jbalcellssUOC/TFG-GEI_Documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation


README.MD


📃 Aquest repositori conté un complet README.md que proporciona accés a tota la documentació interactiva associada a la solució Codis365. Aquesta documentació inclou guies d'usuari desenvolupades amb 📖 GitBooks per facilitar l'ús i la configuració del sistema, així com documentació tècnica de les API generada amb 🔍 Swagger i Redoc per ajudar els desenvolupadors a integrar-se amb la plataforma.


🗊 Taula de Continguts

  1. 📊 Introducció
  2. 🔧 Documentació
  3. 🎥 Video Tutorials
  4. 🔒 Llicència

📊 Introducció

La solució Codis365 es posiciona com una eina integral per a la gestió i traçabilitat dels codis de productes, adaptada a les necessitats d'empreses i desenvolupadors. Aquest repositori actua com a punt central per accedir a totes les guies, documentació tècnica i recursos necessaris per aprofitar al màxim el potencial de Codis365.

A través d'aquest README.md, podràs trobar:

  • Guies d'usuari interactives per entendre i utilitzar les funcionalitats de la plataforma.
  • Documentació d'API detallada per desenvolupar integracions personalitzades.
  • Preguntes freqüents per resoldre dubtes comuns.
  • Tutorials en vídeo per facilitar l'aprenentatge pràctic.

🔧 Documentació

📖 Guies d'usuari i Documentació

La documentació general i les guies per als usuaris estan dissenyades per oferir una experiència intuïtiva. Aquestes inclouen instruccions pas a pas i exemples pràctics per ajudar els usuaris a treure el màxim partit a la plataforma.


💭 Preguntes Freqüents

Un recull de preguntes i respostes comunes que cobreixen diversos aspectes de l'ús i configuració de la plataforma. Aquesta secció ajuda els usuaris a resoldre dubtes sense necessitat d'assistència tècnica.


🔍 Documentació de l'API

Documentació tècnica per als desenvolupadors, que proporciona informació detallada sobre els endpoints de l'API, incloent exemples d'ús i opcions de configuració. Es poden explorar i provar interactuant amb les interfícies Swagger i Redoc.

Aquestes eines permeten una navegació senzilla i l'execució directa de proves sobre els endpoints de l'API.


🎥 Video Tutorials

Els següents vídeos ofereixen explicacions visuals i pràctiques sobre l'ús i les funcionalitats de Codis365. Fes clic en qualsevol enllaç per veure els tutorials:

  1. Com començar amb Codis365
    Introducció a la plataforma mitjançant l'accés amb Doble Factor d'Autentificació (2FA) i primeres passes per configurar i utilitzar les funcionalitats bàsiques.

  2. Gestió avançada de codis
    Tutorial pas a pas sobre com gestionar codis personalitzats i crear catàlegs dinàmics.

  3. Integració de l'API Codis365
    Guia detallada per integrar l'API de Codis365 en aplicacions empresarials.

  4. Exploració de la documentació interactiva
    Com navegar per les interfícies Redoc i Swagger per explorar i provar endpoints.

  5. Millors pràctiques per personalitzar codis
    Consells i trucs per personalitzar codis estàtics i dinàmics.

  6. Creació d'estadístiques amb Codis365
    Aprèn a generar informes i analítiques amb les eines integrades.

  7. Resolució de problemes comuns
    Solucions pas a pas als errors més comuns que poden sorgir en l'ús de Codis365.


🔒 Llicència

Aquest projecte està sota la llicència MIT, que permet l'ús, modificació i distribució amb gairebé cap restricció, fomentant la col·laboració i el desenvolupament obert. Per a més informació, consulta el fitxer LICENSE.

About

Treball Final de Grau, Grau d'Enginyeria Informàtica, User Guides & Technical Documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors