Visualizzazione risultati 1 fino 6 di 6

Discussione: Come si fa un manuale

  1. #1
    Guest

    Predefinito Come si fa un manuale

    Qualcuno conosce dei software per mac per creare manuali per programmi?
    Oppure sapete darmi delle dritte su cosa mettere o su cosa omettere?
    Grazie

  2. #2
    Guest

    Predefinito

    software per un manuale? io farei un semplice pdf...

  3. #3
    L'avatar di seneca
    seneca non č connesso Super Moderatore
    Data registrazione
    18-12-2004
    Residenza
    la Cittā Eterna
    Messaggi
    8,376

    Predefinito

    Citazione Originalmente inviato da sql
    Oppure sapete darmi delle dritte su cosa mettere o su cosa omettere?
    Ma su cosa, su quale argomento?


    -- Aut Roma Aut Nihil!

  4. #4
    Guest

    Predefinito

    Intendi file help?

  5. #5
    L'avatar di dementialsite
    dementialsite non č connesso Super Moderatore
    Data registrazione
    19-10-2004
    Residenza
    fuori Padova
    Messaggi
    5,046

    Predefinito

    Dipende molto da cosa devi fare... ti posso dire che se usi Java hai la possibilita' di sviluppare una documentazione del software contemporaneamente al suo sviluppo, grazie agli strumenti Javadoc. Tutto quello che devi fare e' semplicemente inserire dei "commenti" tipo questo:
    Codice:
    /**
    Breve descrizione della classe
    Descrizione approfondita della classe
    @author Il tuo nome o simile
    @version la versione del programma
    */
    public class NomeClasse extends ... implements ... { ... }
    
    /**
    Breve descrizione del metodo
    Descrizione approfondita della funzione (va bene anche codice HTML se lo conosci)
    @param nome_parametro descrizione_parametro
    @param ... (ripeti come prima per ciascun parametro)
    @return descrizione del valore restituito, se presente
    @exception NomeEccezione se il tuo metodo solleva qualche eccezione e in quali condizioni
    @exception ... (ripeti come prima per tutte le eccezioni)
    */
    public int method (int x, int y) { ... }
    
    /**
    Breve descrizione della variabile
    Descrizione approfondita della variabile (va bene anche codice HTML)
    */
    publid double var;
    Poi, per generare la documentazione, ti basta dare da linea di comando javadoc NomeSorgente.java e vengono automaticamente generati tutti i file di documentazione.

    Stammi bene...
    Le questioni tecniche hanno risposte migliori nel forum pubblico, non trovi?

    When you don't know your next step... improvise

    ALTERVISTA WANTS YOU!
    Vuoi diventare moderatore su AlterVista? Scopri come...

  6. #6
    Guest

    Predefinito

    Io dovrei fare un manuale pdf per un programma fatto in filemaker.
    Questo manuale dovrebbe spiegarne il funzionamento.
    Sto cercando magari degli esempi su come organizzarlo.

Regole di scrittura

  • Non puoi creare nuove discussioni
  • Non puoi rispondere ai messaggi
  • Non puoi inserire allegati.
  • Non puoi modificare i tuoi messaggi
  •