Benvenuto nell'Help Center! Questo tipo di documentazione può essere differente da quella a cui sei abituato e quindi leggi questo documento per capire come contribuire.

Avvio rapido

Per gli impazienti qui ci sono le basi che si devono conoscere:

• devi essere registrato normalmente
• ci sono vari differenti tipi di documentazione, alcuni sono auto esplicativi ma si devono capire le differenze tra un How-to (aiuto) e un Tutorial (manuale) (spiegata più avanti).
• per aggiungere un pezzo di documentazione/aiuto va nella sezione opportuna, assicurati che non vi sia già qualche elemento che tratti lo stesso argomento e usa il pulsante in alto a destra per aggiungerlo (normalmente mostra un aggiungi faq o simile).
• aggiungi il tuo contenuto e salvalo. Il ciclo di modifica/visualizza puoi effettuarlo quante volte desideri finché sei soddisfatto del risultato.
• attento poi, quando hai finito, a sottoporre a revisione il documento per pubblicarlo tramite il menù in alto a destra dell'area del contenuto.
• un revisore dovrebbe quindi prendere il documento e pubblicarlo a meno che il contenuto non debba essere completato.
• se successivamente qualcuno aggiunge un commento al tuo documento verrai avvisato via email.

Di che tipo è la mia documentazione?

Qui sotto c'è una descrizione, l'uso e un esempio per ciascun tipo.

Domande frequenti (FAQ)

Una FAQ (Frequently Asked Question) è una breve domanda con una risposta di 1-2 paragrafi. Puoi aggiungere varie domande ad un'area FAQ e raggruppare le domande in sezioni:

    Esempio FAQ
    Domanda: Cos'è Plone?

    Risposta:
    Plone è un sistema di gestione dei contenuti (CMS - Content Management
    System) open source che gira in Zope e in CMF.

Aiuto (HowTo)

Un HowTo è una descrizione di una paginetta su come ottenere qualcosa ma è un contenitore e quindi può avere degli allegati come file o immagini. Normalmente è molto breve e specifico.

Tipici How-To sono:

• Come impostare Plone con il server web Apache - Come cambiare le schede che appaiono in cima al portale

Guida (Tutorial)

Una guida è un articolo multi-pagina con un sacco di dettagli. Una guida va più in profondità di un How-to e di solito tratta gli aspetti concettuali del problema, oltre a descrivere i passi necessari per eseguire il lavoro.

Se non capisci la differenza tra un How-to e una guida pensa alla differenza tra una ricetta che descrive solamente gli ingredienti necessari e come cuocere il dolce (how-to) e un articolo che spiega la storia dei dolci in generale che può o non può insegnare come realmente cucinarne uno (guida).

Tipici guide sono:

• Uso del portale Plone
• Come utilizzare il workflow nei tuoi progetti
• Perché separare contenuto, logica e presentazione?

Manuale (Reference Manual)

Un manuale di riferimento è un pezzo di documentazione definitivo per qualche prodotto o tecnologia e tende ad essere lungo svariate pagine con sezioni che interrompono il contenuto. Questo è il tipo di documentazione più raro.

Collegamento (Help Link)

Un collegamento è un collegamento (sia esterno che interno). È differente da un normale collegamento Plone in quanto può avere sezioni e informazioni sulla versione.

Tipici collegamenti di aiuto sono:

• The Zope Book su zope.org
• CSS reference manual su W3C

Errori comuni (Error Reference)

Un errore comune vuol essere una spiegazione di un errore particolare con dettagli e trucchi per risolverlo, se rilevante

Tipici errori comuni sono:

• Mi aspetto una sequenza, ottengo un intero
• messaggio di errore: "FS Page Template has errors: Compilation failed"

Glossario (Glossary Definition)

Una definizione in un glossario descrive un termine particolare usato in un contesto nel modo più conciso possibile.

Tipiche definizioni di un glossario sono:

• CMF: Il Content Management Framework (ambiente di gestione dei contenuti)
• Workflow: La struttura del meccanismo a stati usata per descrivere e modellare i vari processi di un lavoro.