Starta din första hjälpcenter

En dokumentationswebbplats är ett värdbaserat hjälpcenter skapat från artiklarna i din arbetsyta, med sökfunktion, en Fråga AI-assistent och feedback från läsare. Den här artikeln tar dig från dina första artiklar till en live-webbplats på din egen adress. Varje steg länkar till artikeln med detaljerna.

Innan du börjar#

• Din roll: arbetsyteägare och administratörer skapar och konfigurerar dokumentationswebbplatser. Innehållsskapare kan lägga till sidor, och redaktörer kan publicera. Se vem som kan göra vad.
• Din plan: dokumentationswebbplatser finns i alla planer, inklusive Free. Free och Starter inkluderar 1 webbplats; Pro inkluderar 2–5, beroende på antal platser. Se Planer och begränsningar för dokumentationswebbplatser.
• Free-plan: publicering kräver en verifierad e-postadress.

Bygg det steg för steg#

1. Skriv dina första artiklar#

   En webbplats visar artiklar, så börja med några stycken. Klicka på Skapa, öppna fliken Artikel och välj en typ: Instruktionsartikel, Felsökning, Standardrutin, Blogginlägg eller Produktuppdatering. Lägg till en inspelning från skrivbordsappen, Chrome-tillägget, en uppladdning, ditt bibliotek eller Spela in med AI, och klicka på Generera artikel. En artikel kostar vanligtvis 5–15 krediter. Se Omvandla en inspelning till en artikel.

   Har du redan ett hjälpcenter någon annanstans? Du kan importera det istället när du skapar webbplatsen (nästa steg).

2. Skapa dokumentationswebbplatsen#

   Klicka på Dokumentsajter i sidofältet och sedan på Ny dokumentationswebbplats. Guiden har tre steg:

   1. Namnge din webbplats: skriv in ett Webbplatsnamn och kontrollera den kostnadsfria Adress, som slutar på .clevera.help. Välj webbplatsens Språk.
   2. Vad ska finnas på den?: välj Från en samling (varje mapp blir en sektion), Välj innehåll, Börja tom eller Importera från ett annat verktyg.
   3. Gör den till din: lägg till en Logotyp, en Varumärkesfärg, ett Typsnitt och Standardutseende.

   Klicka på Skapa webbplats. När du börjar från innehåll publiceras webbplatsen direkt på sin kostnadsfria adress och öppnas på Översikt, med en Kom igång-checklista. Se Skapa en dokumentationswebbplats.

3. Lägg till och organisera sidor#

   Öppna Sidor i webbplatsens sidofält för att lägga till sektioner, lägga till artiklar från ditt bibliotek, skriva nya sidor och ställa in deras ordning. Checklistan kräver minst 5 sidor. Se Lägg till och organisera sidor.

4. Ställ in utseendet#

   Öppna Utseende för att ändra logotyp, varumärkesfärg, webbplatsstil, typsnitt och sidhuvudet på din startsida. En live-förhandsgranskning visar varje ändring. Ställ in menyerna i sidhuvudet och sidfoten under Navigering. Se Anpassa utseendet på en dokumentationswebbplats och Ställ in sidhuvud och sidfot för en dokumentationswebbplats.

5. Aktivera Fråga AI#

   Assistenten är avstängd på en ny webbplats. Gå till Inställningar → AI-assistent, aktivera Visa assistenten, välj vad som ska hända När den inte kan svara, och klicka på Spara. Den svarar endast baserat på dina publicerade sidor och listar sina källor. Svar kostar inga krediter; din plan inkluderar ett månatligt antal svar (300 på Free). Se Ställ in assistenten för dokumentationswebbplatsen.

6. Välj vem som kan läsa den#

   Varje webbplats är offentlig som standard. För att göra den privat, gå till Inställningar → Åtkomst och välj Lösenord eller Inloggning till arbetsyta. Privata webbplatser kräver Pro eller högre. Se Kontrollera vem som kan läsa en dokumentationswebbplats.

7. Publicera#

   Klicka på Publicera i webbplatsens sidhuvud, kontrollera listan över ändringar och bekräfta (knappen läser till exempel Publicera 3 ändringar). Läsare ser den nya versionen inom några sekunder, och varje version sparas under Publicerar så att du kan återställa. Publicera automatiskt är aktiverat för nya webbplatser: när webbplatsen är live, publiceras sparade ändringar efter cirka två minuter utan redigeringar. Se Publicera en dokumentationswebbplats.

8. Anslut din egen domän#

   Anpassade domäner kräver Starter eller högre. Öppna Domän, ange en underdomän som help.example.com och klicka på Anslut. Lägg till CNAME-posten som Clevera visar hos din domänleverantör och klicka sedan på Kontrollera nu. Certifikatet tar vanligtvis 5–30 minuter; när statusen är Live, omdirigeras den kostnadsfria adressen till din domän. Rotdomäner som example.com kan inte anslutas. Se Anslut en anpassad domän till en dokumentationswebbplats.

Låt Autopilot bygga den#

Med Pro och högre kan Autopilot bygga och underhålla hjälpcentret åt dig. Klicka på Autopilot i sidofältet för att börja; se Få tillgång till Autopilot. Endast arbetsytans ägare eller en administratör kan använda byggreceptet.

Bygg ett hjälpcenter från din app#

I Autopilot, klicka på receptet Bygg ett hjälpcenter från min app, eller skriv "Bygg ett hjälpcenter åt mig" i Vad ska Autopilot göra?. Clevera-agenten visar ett konfigurationskort. Klicka på Fyll i detaljerna, lägg till din Webbplats och App-adress, välj en inloggning och välj webbplatsens språk.

Under Befintligt hjälpcenter, välj Börja från början, eller Importera det och välj Intercom, Zendesk, Help Scout, GitBook, ReadMe, Mintlify, Document360, Docusaurus eller En annan dokumentationssajt. Importen läser endast offentliga sidor och är gratis. Notion och Confluence importeras från webbplatsens inställningar när den väl finns.

Uppgiften körs i fyra steg: Varumärke, Webbplats och videor, Artiklar samt Granska och publicera. Planering är gratis. Du ser varje stegs plan och dess krediter, och ingenting körs förrän du klickar på Kör. Ett typiskt bygge kostar 240–560 krediter och tar 1–3 timmar. Clevera publicerar aldrig webbplatsen åt dig: i det sista steget väljer du artiklarna och klickar på Publicera. Se Bygg ett hjälpcenter från din app med Autopilot.

Håll det uppdaterat när du levererar#

När webbplatsen väl finns, bevakar receptet Håll mitt hjälpcenter uppdaterat när vi levererar ett arkivs releaser eller sammanslagna ändringar, en ändringsloggsida eller en ändring du beskriver. Varje gång något ändras kontrollerar Clevera de berörda videorna och artiklarna och planerar korrigeringarna. Varje körning väntar på din granskning; en typisk körning kostar 10–150 krediter. Se Håll ditt hjälpcenter uppdaterat när du levererar.

Relaterat#