Hej, allihopa!
I min förra video talade jag om hur man skapar produktdokumentation och redigerar sin produktdokumentation. Dessutom visade jag hur man bäddar in videor, bilder, media samt kod så att du kan skapa produktdokumentation så att du kan utbilda dina kunder ytterligare om dina tekniska plattformar och lösningar.
Nu ville jag göra en djupdykning i produktdokumentationsplattformen Docsie och visa dig hur du enkelt och lätt kan skapa programvarudokumentation.
Här är en snabb handledning som förklarar hur man publicerar med Docsie.
Publicering med Docsies kunskapsportal kan göras på ett par olika sätt. I den här videon förklarar jag hur man publicerar med Docsies kunskapsportaler, böcker, hyllor eller artiklar med en enkel kodrad.
I det här exemplet ville jag publicera den här specifika boken som heter "Writing your first Django app, part 2".
Som du kan se i min nuvarande, redan skapade programvarudokumentation har jag skrivit en version som heter "Brand new portal that I am working on" (helt ny portal som jag arbetar med) och om du klickar på verktyget "penna" nära den har du möjlighet att göra din publicerade portal "aktiv" eller "primär" eller stänga av dessa funktioner, vilket är fantastiskt, eftersom det innebär att du och ditt team kan skriva eller uppdatera er dokumentation utan att den är synlig för era kunder eller klienter tills ni är redo att publicera den, och att ni kan börja använda den skapade produktdokumentationen i produktion på er webbplats:
När du nu är redo att publicera är det dags att distribuera din dokumentation! Detta görs enkelt genom att först klicka på de tre prickarna i det övre högra hörnet av Docsie-plattformen och sedan klicka på ditt konto:
När du har kommit till sidan Profil och inställningar klickar du på fliken "Deployments", som för dig till sidan Deployment och hjälper dig att skapa din inbäddningskod som ska placeras på din webbplats.
Klicka nu på "Konfigurera en ny distribution +".
Bra! Nu när du har tillgång till instrumentpanelen behöver du bara distribuera en anpassad domän, vilket är enkelt genom att öppna fliken "Deploy a domain:" och klicka på "custom deployment".
Nästa två steg är enkla:
-
Det första steget är att skriva in din domän (kom ihåg att använda http:// eller https:// innan du skriver ditt domännamn).
-
Det andra steget är att välja vad du vill publicera, du kan välja att publicera, en bok eller en hel hylla. I det här exemplet publicerar jag en bok med följande innehåll: "Writing your first Django app, part 2".
Bra! Nu är det sista steget innan vi får vår kod att klicka på "+More Options".
Nu kan du använda våra olika insticksprogram, funktioner och andra dokumentationsalternativ för att krydda din kunskapsportal och göra den mer praktisk för dina användare. Dessa funktioner, plugins och verktyg för produktdokumentation är ganska smarta och gör dina kunskapsportaler mer robusta.
Obs: du kan ändra dessa ytterligare funktioner och plugins och andra verktyg för produktdokumentation när som helst.
När det är klart klickar du på "Create web portal" (Skapa webbportal).
Scrolla nu ner till botten och klicka på "+ Get deployment script".
Kopiera skriptet och klistra in det i din HTML:
Nu när du har tillgång till ditt skript kan du krydda det hela med vår CSS-användarhandledning, som hjälper dig att skapa en snygg Docsie-kunskapsportal som matchar ditt varumärkes utseende och känsla. Läs igenom vår användarguide för styling i den här länken här: [Docsie's styling guide] (https://help.docsie.io/?doc=/publish-documentation-portal/docsie-styling-guide/base-style/)
Jag hoppas att du gillade den här handledningen, håll utkik efter fler Docsie-handledningar inom en snar framtid!
Om du har några frågor om hur Docsie kan hjälpa dig och vill att vi ska visa dig en demo av våra verktyg är du välkommen att Klicka här för att boka en demo med oss.