Comprendere i siti di documentazione
I siti di documentazione trasformano i tuoi articoli Clevera in un help center ospitato, completo di ricerca, un assistente IA, feedback dei lettori e lingue. Ecco cosa ottengono i lettori, chi può fare cosa e cosa consuma crediti.
Un sito di documentazione è un help center ospitato creato a partire dagli articoli nel tuo workspace Clevera. Scrivi e modifichi gli articoli dove si trovano già, li aggiungi a un sito come pagine e pubblichi. I lettori ottengono un sito pubblico veloce con ricerca, un assistente IA che cita le tue pagine e un modo per segnalarti cosa non è stato utile. I siti di documentazione sono inclusi in ogni piano, anche quello Free.
Come funziona un sito di documentazione
- I tuoi articoli sono le pagine. Una pagina su un sito di documentazione mostra un articolo dalla tua libreria. Modifica l'articolo e la pagina cambierà alla pubblicazione successiva. L'articolo rimane in Contenuto; rimuovere la pagina dal sito non lo elimina mai.
- Pubblichi le versioni. Le modifiche si accumulano finché non vengono pubblicate come nuova versione. Ogni versione viene conservata in Pubblicazione, così puoi vedere cosa è cambiato ed eseguire il rollback.
- Ha il suo indirizzo. Ogni sito ottiene un indirizzo gratuito,
your-site.clevera.help. Con il piano Starter e superiori puoi servirlo dal tuo dominio, comehelp.example.com. - I lettori non vedono mai il tuo workspace. Vedono solo il sito. Le persone nel tuo workspace lo gestiscono da Siti di documentazione nella barra laterale.
Ogni sito ha queste schermate, raggruppate nella sua barra laterale:
| Gruppo | Schermate | Cosa fai lì |
|---|---|---|
| Panoramica | Panoramica | Checklist di configurazione, traffico e cosa fare dopo |
| Contenuto | Pagine, Registro modifiche, Redirect | Sezioni, pagine e il loro ordine; note di rilascio; vecchi indirizzi |
| Approfondimenti | Analisi, Cerca, Assistente, Feedback | Visualizzazioni, cosa hanno cercato e chiesto i lettori, valutazioni delle pagine |
| Sito | Aspetto, Navigazione, Dominio, Impostazioni, Pubblicazione | Aspetto, menu, il tuo dominio, accesso e assistente, versioni |
Cosa ottengono i lettori
| Funzionalità | Cosa vedono i lettori |
|---|---|
| Home page | Un titolo, una casella di ricerca, le tue sezioni come schede argomento e le pagine in evidenza |
| Cerca | Cerca… nell'intestazione, o ⌘ K / Ctrl K da qualsiasi pagina. I risultati si aggiornano mentre scrivono e ricordano le ricerche recenti. |
| Assistente IA | Chiedi all'IA risponde alle domande dalle tue pagine pubblicate ed elenca le fonti utilizzate. Lo attivi in Impostazioni → Assistente IA. |
| Feedback pagina | "Questa pagina è stata utile?" alla fine di ogni pagina, con motivi opzionali e un commento |
| Lingue | Un selettore di lingua nell'intestazione quando il sito ha più di una lingua. Una pagina senza traduzione mostra la lingua predefinita con un breve avviso. |
| Chiaro e scuro | Un interruttore del tema nell'intestazione. Imposti tu quello predefinito. |
| Azioni pagina | Copia una pagina come Markdown, visualizzala come testo semplice o aprila in un'app di chat IA per fare domande a riguardo |
| Copie leggibili da macchine | llms.txt e copie Markdown delle pagine pubbliche per strumenti IA, più una sitemap per i motori di ricerca |
| Registro modifiche | Una pagina di note di rilascio con categorie (Nuovo, Migliorato, Corretto, Sicurezza, Deprecato) e un feed RSS |
| Modulo di contatto | Contatta l'assistenza invia un messaggio a un indirizzo email che confermi (Starter e superiori) |
I siti sul piano Free mostrano un piccolo badge "Powered by". I piani Starter e superiori possono rimuoverlo.
Chi può fare cosa
I siti di documentazione utilizzano i ruoli del tuo workspace. Tutti nel workspace possono aprire ogni sito di documentazione.
| Attività | Proprietario | Amministratore | Editor | Content Creator |
|---|---|---|---|---|
| Aprire siti, pagine e approfondimenti | Sì | Sì | Sì | Sì |
| Modificare pagine, sezioni e voci del registro modifiche | Sì | Sì | Sì | Sì |
| Aggiungere nuovi articoli, pagine del sito e voci del registro modifiche | Sì | Sì | No | Sì |
| Pubblicare, eseguire rollback, cambiare aspetto, navigazione, dominio e impostazioni | Sì | Sì | Sì | No |
| Creare un sito di documentazione | Sì | Sì | No | No |
| Eliminare un sito di documentazione | Sì | Sì | No | No |
| Importare ed esportare contenuti | Sì | Solo visualizzazione | No | No |
Gli Editor migliorano ciò che esiste e lo pubblicano; non creano nuovi contenuti. I Content Creator scrivono e modificano, e un proprietario, amministratore o editor pubblica. Dove un controllo è disattivato per il tuo ruolo, il suo tooltip spiega il motivo, ad esempio "Solo i proprietari e gli amministratori del workspace possono creare siti di documentazione."
Cosa consuma crediti
Ospitare un sito di documentazione è gratuito. La maggior parte di ciò che accade su di esso non consuma crediti.
| Azione | Crediti |
|---|---|
| Hosting, visualizzazioni pagina, visitatori e larghezza di banda | Nessuno |
| Ricerca del lettore | Nessuno |
| Risposte dell'assistente ai lettori | Nessuno. Ogni piano include un numero mensile di risposte. |
| Traduzione di titoli pagina, nomi sezioni, etichette menu | Nessuno |
| Pubblicazione, rollback, redirect, analisi | Nessuno |
| Importazione da un'altra piattaforma, esportazione di un sito | Nessuno |
| Generazione o traduzione di una pagina del sito con IA | Crediti IA articoli. La finestra di dialogo mostra "Fino a N crediti" prima di iniziare. |
| Traduzione di voci del registro modifiche | Crediti IA articoli |
| Scrittura di un articolo con IA (in Compose o nell'editor articoli) | I soliti crediti articoli |
Vedi Comprendere i crediti per sapere come funzionano i crediti e Piani e limiti dei siti di documentazione per cosa include ogni piano.