Strumenti per la documentazione

Telegram

Telegram è una piattaforma di messaggistica utilizzabile sia da smartphone sia da pc. Il gruppo documentazione è  Odoo ITA - Documentazione.

Editor RST online

Per la creazione dei documenti si utilizza il formato RST (per un riferimento vedere questa pagina).
Un comodo editor online con anteprima in tempo reale si trova a questo indirizzo.

Atom

Atom è un IDE open source consigliato per l'elaborazione dei file RST in locale.

GitHub

GitHub è la piattaforma di condivisione del software scelta da OCA. La piattaforma è nata per il codice ma si adatta molto bene anche alla gestione dei file RST in modo collaborativo.

LibreOffice Writer

Libre Office è un pacchetto di programmi open source gratuito che contiene tra gli altri il programma Writer. Con questo programma posso essere realizzati i documenti senza l'utilizzo di RST.

Linee guida 

  • Metodo di gestione della documentazione .
    Sequenza dettagliata delle operazioni da eseguire dalla presa in carico alla pubblicazione dei documenti.

  • Suggerimenti per la realizzazione dei documenti
    Consigli su come analizzare gli argomenti da documentare e come organizzare i documenti.

  • Formati e standard da utilizzare
    Definizione dei formati di testo e immagini da utilizzare nei documenti e convenzioni sui nomi delle risorse.


Vai alle linee guida