BLOG

Come realizzare documentazione con Genropy

Genropill 8 - Come costruire una documentazione gerarchica con Genropy

Nel nostro lavoro ci può capitare di dover redigere una documentazione di tipo tecnico, come ad esempio un manuale utente relativo a un applicativo che abbiamo realizzato, oppure semplicemente un qualunque materiale informativo articolandone il contenuto in modo gerarchico, con link, immagini, frammenti di codice, video o documenti allegati.

La soluzione tipica è la realizzazione di un manuale composto da file organizzati in directory su disco. Questa soluzione può però apparire limitata nella funzionalità e laboriosa da aggiornare e modificare. Genropy ed Erpy, l’ERP italiano realizzato con Genropy, utilizzano invece l’approccio basato su una web application realizzata in Genropy in cui ogni voce è un record di una table gerarchica contenuta su un database in cloud.

Il pacchetto DOCU di Genropy fornisce uno strumento per creare una documentazione tecnica, sotto forma di raccolta di argomenti gerarchici. Il pacchetto, al momento ancora in alpha ma già operativo, è stato concepito principalmente per uso interno per documentare Genropy e/o i pacchetti con esso realizzati ma si può facilmente adattare a un’ampia gamma di contesti.

I vantaggi di questo approccio rispetto al più tradizionale “file” sono notevoli, in particolare:

  • gestione degli allegati e delle immagini direttamente nell’applicazione e non in cartelle esterne;
  • aggiornamento automatico dei link interni in caso di modifica della struttura gerarchica o dei nomi delle voci di documentazione;
  • in caso di documentazione multilingua, assegnazione di allegati e immagini alla voce invece che al singolo contenuto in una lingua o nell’altra;
  • generazione automatica dei file html e pubblicazione della Documentazione direttamente online tramite esportazione con Sphinx

Il video seguente ci mostra come “attivare” il package DOCU nei nostri progetti Genropy, nonché il suo funzionamento, dalla strutturazione della table Documentazione all’esportazione con Sphinx.

Per attivare i sottotitoli premere il bottone CC

Ti interessa approfondire il funzionamento del Documentatore di Genropy?


Ti stai avvicinando al mondo Genropy e desideri saperne di più? Seguici sui social per tenerti in contatto con le ultime novità che Genropy ha da offrire:

Genropy Seguici su Facebook
Pagina Facebook

Genropy Seguici Gruppo Facebook
Gruppo Facebook

Entra a far parte del Gruppo LearnGernopy su Telegram
Gruppo Telegram