Skip to main content

FR-11 - Documentazione Markdown della libreria

Scopo

Fornire una documentazione dettagliata in Markdown per installazione, configurazione e utilizzo dei componenti/servizi.

Descrizione

La libreria deve includere documentazione che copra almeno:

  • installazione e prerequisiti (PrimeNG/Bootstrap)
  • configurazione UI provider (FR-01)
  • guida rapida per componenti base/avanzati (FR-02/FR-03) con esempi
  • guida servizi (storage, logging, form, auth opzionale)
  • guida AutoForm con esempi di schema JSON
  • guida tabella server-driven
  • guida menu laterale e servizio toggle

Acceptance Criteria (Gherkin)

Feature: FR-11 Documentazione
Scenario: Developer onboarding
Given un nuovo sviluppatore
When segue la guida di installazione e il quickstart
Then riesce a rendere un Button e una Table con provider scelto senza informazioni extra

Dipendenze

  • Tutti i FR precedenti (la doc deve coprire i contenuti)

Impatti

  • Riduce tempi onboarding e errori d’uso.

Requisiti non funzionali correlati

  • NFR-07

Tracciabilita

  • Req -> Story: US-11
  • Story -> Test: Review checklist

Changelog

  • 2026-01-08: creazione iniziale