Många SaaS-teknikföretag kämpar med att utveckla och distribuera produktdokumentation (användarhandböcker, användarhandböcker och/eller handledning) till sina kunder.
Ofta beror detta på bristande kunskaper eller processer om korrekt hantering och produktion av manualer, eller till och med om vem som är ansvarig för dem.
Så länge som det finns behov av verktyg och programvara i världen kommer vi att behöva effektiv kommunikation för att effektivt förmedla till andra hur dessa varor används, utvecklas, fungerar och är uppbyggda. Om du undrar varför det är så är svaret enkelt. Det beror på att färdigheter i teknisk kommunikation är avgörande för att samla in information och göra det möjligt för publiken att förstå produkten eller tekniken mer effektivt.
Medan kommunikation i den verkliga världen sker genom tal, kroppsspråk och känslouttryck, sker teknisk kommunikation i den virtuella världen genom teknisk produktdokumentation!
Det enda syftet med teknisk produktdokumentation är att underlätta användarens förståelse av en produkts och tekniks dynamik och arkitektur. Det är mer som en handbok om hur man använder en produkt för nyanställda, användare/kunder och alla andra som måste känna till arbetsmetoderna, en grundlig beskrivning av en produkts skruvar och muttrar!
Det är produktchefernas uppgift att ta på sig ansvaret för att utveckla ett team som skapar, förvaltar, publicerar och underhåller en väl utarbetad produktdokumentation.
Jag är säker på att varje produktchef har sagt eller hört följande på sin avdelning: "Produktdokumentation är en del av produktägarens skyldigheter", "Varje utvecklingsteam bör dokumentera sina egna appar", "Funktionen har tagits i bruk, har manualen uppdaterats?" eller, mycket värre, "Det finns ett fel i den tekniska dokumentationen".
Det är uppenbart att teknisk produktdokumentation kan vara lite förbryllande, även om den är så enkel som den verkar! Medan enskilda personer försöker lösa eller argumentera om raderna i föregående stycke försämras manualer och handledningar, vilket är skadligt för din "produkt/företagets" image.
För att hjälpa alla som upplever liknande problem finns här några förfaranden att genomföra för att optimera din produktdokumentation.
Vad är syftet med produktdokumentation?
När man talar om produktdokumentation för en teknisk produkt eller tjänst talar man om den information som beskriver den och de uppgifter som hör till den.
Teknisk dokumentation, eller produktdokumentation, handlar om att hjälpa din publik och dina kunder att använda, läsa, förstå och använda din produkt. De flesta produktdokumentationer produceras förstås inom olika områden, bland annat teknik, medicin, informationsteknik och marknadsföring.
En bra teknisk produktdokumentation hjälper din publik att navigera i din produkt och gör det möjligt för dem att använda den utan komplikationer.
Ett annat övervägande är att teknisk dokumentation är avgörande för kundstödet och bidrar i hög grad till ditt företags varumärke och förtroende. När de är i störst behov söker användarna efter teknisk dokumentation. Målgruppen använder din produkt för att lära sig om processerna och hantera problem.
Detta innebär att det är mycket viktigt att ha en grundlig och omfattande produktdokumentation som är dynamisk med sökfunktioner.
Vilka är de olika produktdokumentationerna?
I det här avsnittet kan du se vilken typ av produktdokumentation du behöver för dina kunder eller klienter.
Det finns många olika typer av produktdokumentation som tillgodoser behovet av olika typer av användningsfall och användarbehov:
Produktanvändardokumentation: Denna består av användarmanualer, instruktionsböcker, handledningar, vanliga frågor och svar, versionsanvisningar och utbildningsmanualer samt driftrutiner.
Företagsdokumentation: Undersökningar visar att mer än 8 av 10 företag, av 1000 undersökta företag, använder formella policys och procedurhandböcker.
Det finns många andra företagsdokumentationer som består av dokumentation som hänvisar till företagets riktlinjer och förfaranden enligt forskningen ovan, instruktionsmanualer, tekniska metoder, beteendemässiga och etiska dokumentationer. Samt juridisk dokumentation som kan vara lösenordsskyddad. Även företagsstrukturer, bästa praxis och förfaranden samt underhållsmanualer.
Dokumentation för utvecklare: Denna typ av dokumentation innehåller instruktioner för utveckling av mjukvaruprodukter, funktionsspecifikationer, tekniska specifikationer, dokumentation och verktyg som underlättar utvecklarnas arbetsflöde.
Nu när vi bättre förstår de olika typerna av teknisk dokumentation och produktdokumentation kan vi diskutera vad de första stegen i en solid hantering av produktdokumentationsutvecklingsprocessen börjar med.
Hitta en chef för utveckling av produktdokumentation.
En mycket typisk fråga är att fastställa vem som ska ansvara för produktdokumentationen, inte som någon som bara uppdaterar den, utan som någon som är ansvarig för produktens kvalitet och framgång.
Medan vissa företag anser att varje produktägare och/eller produktchef är ansvarig för produktdokumentationen, kan även andra avdelningar som utveckling och support docs anförtros ansvaret för att hålla användarmanualer, användarhandböcker och alla aspekter av produktdokumentationen aktuella och effektiva.
Utvecklingen av produktdokumentation har många rörliga delar, men här kommer vi att peka på två av dem:
-
Vem förstår hur produkten fungerar på alla nivåer (detta inkluderar även produktutvecklings- och specifikationsteamen).
-
De som får input från kunder som går igenom produktdokumentationen och lyssnar på deras svårigheter, feedback och oro för att förstå den aktuella produktdokumentationen.
Den första delen hjälper oss att skapa den tilldelade produktdokumentationen med den kunskap som finns tillgänglig, och denna skickas ut till kunden som i sin tur ger feedback och inleder de andra processerna som bidrar till att optimera dokumentationen.
Ibland är dessa två punkter inte helt och hållet på plats, och detta leder till situationer där produktdokumentationen aldrig får den uppmärksamhet som krävs.
En metod är att utse en person som ansvarar för produktdokumentationen, produktmanualerna och användarhandböckerna. Tänk på en inköpsorder som har "Produktdokumentation" som sin produkt. Han är ansvarig för att gå igenom alla företagets team, skissa på hur varje produkt genererar sina guider och identifiera de utmaningar som är förknippade med den processen.
Avsikten är inte att denna produktägare och produktchef ska vara helt ansvarig för att generera och ändra handböcker, utan att hjälpa individer inom varje team på med dokumenthantering.
Denna person bör studera hur användarna interagerar med dokumenten, erbjuda sätt att göra uppdateringarna smidigare och samla in feedback för att avgöra hur man kan förbättra varje produkts dokumentation och förklaringar med dess avsedda målgrupp.
Att ha någon som ansvarar för alla aspekter av produktdokumentationen, hanterar arbetsflödet och de olika avdelningar som måste slutföra denna dokumentation kommer att öka produktiviteten inom företaget, skapa medvetenhet och utbilda kunder med kunskapsportaler om produkten och överlag effektivisera produktförståelsen.
Se på produktdokumentationen som själva produkten.
Produkter finns till för att leverera ett värde som uppfyller eller överträffar kundens förväntningar. Baserat på statistik genererad av D2WorldWide anser 73,7 % att dokumentation är mer hjälpsam än videor, förpackningar eller säljare när de söker information om produkter som de överväger att köpa.
Tänk på de faktorer som bidrar till en produkts attraktivitet. Det finns flera faktorer som kan påverka en produkts attraktionskraft, men för den här artikelns skull kommer vi att koncentrera oss på tre. De överträffar förväntningarna när det gäller värde, användningen genererar tillfredsställelse och de är konkurrenskraftiga.
Dessutom gäller samma begrepp för bra produktdokumentation online. Produktdokument som går "utöver det förväntade värdet" illustrerar inte bara hur man använder den specificerade produkten, utan erbjuder också lösningar som kunden inte känner till eller inte tror är möjliga. Det är alltid nödvändigt att se hur andra företag inleder sin produktdokumentation för att lära sig av deras framgångar och misstag.
Det är meningslöst att ha ett företag som utvecklar unika och högkvalitativa programvaror som ligger före konkurrenterna om de utvecklare och kunder som integrerar era tekniska produktdokument inte kan förstå dem.
Tänk på att den person som läser produktdokumentationen kanske inte är bekant med det utbud av möjliga lösningar som produkten erbjuder eller med marknaden (vilket ofta är fallet med tekniska SaaS-produkter), och därför måste de "utbildas" om dessa lösningar och olika alternativ i samband med produkten.
Produktdokument vars "användbarhet skapar tillfredsställelse" följer ett logiskt läsmönster som är anpassat till målgruppen. Det tjänar inget till att ha den mest grundliga manualen på jorden om den är en 500-sidig PDF-fil eller inte innehåller ett kodexempel och inte är dynamiskt skapad med sökfunktioner och andra funktioner. Samla in feedback från användarna av ditt produktdokument och din supportpersonal. De kommer att fastställa de viktigaste stressområdena i samband med de rapporterade uppgifterna.
Konkurrenskraftig produktdokumentation är den som kontinuerligt uppdateras med hjälp av de mest effektiva teknikerna för informationsutbyte. De har fantastiska funktioner som inbyggda sökfunktioner, översättningar, olika versioner, inbäddade bilder, videor och mycket mer!
Även om din integrationsguide är den bäst skrivna av alla teknikföretag kommer den att sakna attraktionskraft utan en tillagd video och bilder och koder som kan kopieras och klistras in för att underlätta användningen för dina tekniskt kunniga kunder som köper dina tekniska SaaS-produkter.
Det är alltid nödvändigt att se hur andra företag inleder sina dokument för att lära sig av deras framgångar och misstag.
Det är meningslöst att ha ett företag som utvecklar unika och högkvalitativa programvaror som ligger före konkurrenterna om de utvecklare och kunder som integrerar era dokument inte kan förstå dem i sin helhet.
Recommendation om produktdokumentation
Effektiv teknisk produktdokumentation förbättrar slutanvändarens upplevelse genom att polera processen för att förstå produkter och diagnostisera eventuella problem med lätt tillgängliga skriftliga lösningar. När kunderna litar på och förstår hur de ska använda era produkter kan de komma tillbaka till er i framtiden när behovet uppstår.
[Ny forskning från SDL] (https://www.tcworld.info/e-magazine/technical-writing/technical-product-information-impacts-brand-perception-893/) visar att dokumentationens roll på de globala marknaderna ökar. Undersökningen visar att cirka 53 % av köparna gör inköp med hjälp av teknisk litteratur innan de ens har provat produkten. En annan statistik från denna undersökning visar att 94 % av köparna anser att det är till hjälp och nytta att ha produktinformation på en enda plats. På grund av detta lägger alla företag lika stor vikt vid produktdokumentation som vid produktutveckling eller testning i dag.
Även om dokumentationen har en utsedd ägare som leder dokumentationsgruppen, de har skapat produktdokumentation som har reviderats och bedömts för att förbättra användbarheten, och som har uppdaterats ordentligt, fortsätter ni att kämpa för att få era användare och konsumenter att förstå era tekniska produkter. Detta kan bero på att användarna/läsarna inte kan förstå hur dina dokument läses eller vilka frågor de egentligen ställer. Detta gör att en av de mest utmanande aspekterna av dokumentkomposition är att sätta sig in i läsarens situation. När allt kommer omkring bör den som producerar produktdokumentationen ha en gedigen förståelse för produkten.
Denna expertis kan göra att författaren förbiser saker som inte är så uppenbara för den genomsnittlige användaren. Typiskt sett inträffar detta när något som är självklart för dem som skapar produkten inte är helt klart för dem som köper och använder produkten.
Detta kan ske på olika sätt:
Skrivstruktur eller form: Även om detta kan tyckas vara ett subjektivt ord, kan även det sätt på vilket en handbok är skriven skapa förvirring. Det är viktigt att identifiera vilken typ av läsare som läser dokumentationen, annars kan ord som "Utvecklare föredrar exempel framför beskrivande text" eller "Vår dokumentation är inte tydlig trots förekomsten av exempel och visuella bilder" förekomma.
Tema organiserat i manualer: Ibland utvecklar företag som är verksamma på samma marknad ett standardiserat dokumentationsformat. Om era företagsguider inte följer det kan läsaren få en känsla av främlingskap.
Överdriven användning av underförstådda termer: När de tillämpas i en handbok kan förkortningar vara föga meningsfulla, även om fraserna inte är akronymer. Det är svårt att uppfatta, men vissa ord, såsom "status", "id", "credentials", och innehåller en implicit betydelse förklädd till explicit. Använd särskilda beteckningar, till exempel "användaridentitet" i stället för "UID".
Valid översättning: Översättning är en stor del av den globala räckvidden. Många gånger skapar företag dåligt översatta användarmanualer och produktdokumentation som inte stämmer överens med kulturen i vissa länder eller helt enkelt så översätts orden inte på samma sätt som de skulle översättas på engelska till det aktuella landet. Genom att förstå dessa subtila nyanser kan produktdokumentationen komma långt från oläsbar information till en heltäckande och översatt produktdokumentation.
För att undvika sådana situationer är målet att utveckla en lösning som samlar in och analyserar användarfeedback och navigeringsmönster.
Återkopplingsverktyg som Vocally a Docsie-funktionen är ett utmärkt sätt att samla in och utvärdera navigeringsmönster och kartlägga hur dina kunder ser på din produktdokumentation. [Lär dig de 7 gyllene reglerna för att samla in feedback här] (https://www.docsie.io/blog/articles/7-golden-rules-to-successfully-approach-customer-feedback/).
Denna information är avgörande för att uppdatera och optimera dina användarhandböcker, användarmanualer och produktdokumentation för att skapa en mer sömlös upplevelse för dina kunder när de ska lära sig mer om dina produkter. Inget är mer frustrerande än att införa en ny produkt och upptäcka en ökning av supportförfrågningar på grund av dåliga manuella instruktioner.
Hur man skriver omfattande produktdokumentation
Produktdokumentation av hög kvalitet är fängslande, användbar och kraftfull. Jag skulle vilja påstå att skicklig dokumentation är en nödvändig del av god produkthantering. Även om produktcheferna spelar en stor roll i produktutvecklingen, är en betydande del av framgången att skapa fantastisk polerad produktdokumentation som våra kunder kan förstå och använda för att fördjupa sin kunskap om våra produkter.
Vad är det som händer med den mesta produktdokumentationen?
Många produktchefer är ovilliga att skriva produktdokument. De produktdokument som de är bekanta med kanske inte har någon dragningskraft hos kunderna om man inte ser till att göra dem tilltalande, lättlästa och lättförståeliga.
Många gånger är det dock så att företagen inte tar den omsorg som krävs för att skapa och utforma fantastisk produktdokumentation. Dålig produktdokumentation är skriven enbart i syfte att vara skriven. Den använder expansiva fraser fyllda med vagt acceptabla tankar och dålig layout för att avskräcka tittarna från att interagera med materialet. En dålig produktdokumentation skapas för att skydda författaren från kritik och är ett fullständigt slöseri med allas vår tid. Och deras kunder ogillar att läsa den även av denna anledning.
Hur åtgärdar vi detta och skriver bättre produktdokumentation som våra kunder tycker om att läsa?
Utmärkt produktdokumentation är skriven med avsikt att bli läst. Den är kortfattad. Bra produktdokumentation är välformaterad och kan läsas och förstås av alla i företaget eller av kunderna på tre minuter. Den undviker jargong och ger eller hänvisar till synpunkter på affärsnivå. En utmärkt produktdokumentation ägnar tid åt att beskriva specifika användningsfall som kunderna kan förstå och tillämpa för att förbättra användningen av produkten. Den engagerar läsaren och uppmärksammar underliggande problem med väl utarbetade lösningar.
Styrkan hos en välskriven produktdokumentation
I små, medelstora och stora företag kan välformulerade tekniska produktdokument spara mycket tid och hjälpa de anställda att arbeta mer produktivt. Detta gäller i allmänhet för de flesta produktbaserade företag, som lägger en stor del av sin budget på att anställa tekniska skribenter och skriva teknisk produktdokumentation.
Om ditt företag anställer mer än två personer för att skapa produktdokumentation är det helt värt att etablera en kultur för god dokumentation. Det finns många anledningar till varför du vill att ditt team ska skapa, hantera och publicera välgjord produktdokumentation, men i avsnittet nedan kommer vi att ta upp hur effektiv produktdokumentation är en billig metod för att förbättra kundupplevelsen.
Effektiv produktdokumentation är ett billigt sätt att förbättra kundupplevelsen.
En gedigen kundupplevelse är den främsta förutsättningen för att behålla och bibehålla lojala kunder. De flesta projektledare är optimister - de får ett koncept, blir entusiastiska och genomför sedan. Även om passion är beundransvärt och utförandet verkar produktivt är det viktigt att ha en spelplan innan man utför korrekt produktdokumentation.
De första stegen efter att ha tagit fram en spelplan är att inleda en designcykel och strukturera innehållet i produktdokumentationen på ett sådant sätt att det successivt blir lätt att läsa för kunderna.
Att få feedback från kunderna om deras nuvarande dokumentation är också ett viktigt steg som behövs för att omstrukturera dokumentationen så att den motsvarar kundernas behov. På detta sätt kan projektledare skapa, hantera, underhålla, publicera och optimera sin dokumentation med hjälp av perception och automatisering. Detta är inte en enkel och minikväll uppgift, och att ha fantastiska verktyg som Docsie som automatiserar många av processerna för att göra produktdokumentationen effektiv är helt avgörande för att lyckas.
Attraktiv, engagerande och navigerbar teknisk dokumentation hjälper konsumenterna att lära sig produkten på kortare tid, vilket ökar sannolikheten för att de kommer att installera produkten korrekt och använda den på rätt sätt.
Alla dessa strategier för att skapa välpolerad produktdokumentation kommer i huvudsak att leda till högre betygsatta produkter, mer gynnsamma recensioner och mer försäljning är alla knutna till varandra; därför är det självklart att den ökade försäljningen som ett resultat.
Hur man skapar välgjord produktdokumentation
Hur skapar man effektiv dokumentation och främjar en kultur där den är standard? Att skriva effektiv dokumentation är en utmaning, men det finns många bra funktioner i Docsie som kan hjälpa till att sätta igång denna process för att skapa välgjorda och dynamiska portaler för produktdokumentation. Nedan följer en sammanfattning på hög nivå av hur vi närmar oss frågan.
Nu kan vi börja:
Sidbegränsningar säkerställer läsbarhet. Att skriva ett anständigt dokument bör inte vara svårt att läsa och mentalt bearbeta. Långdragna, slingrande fraser är ofta ett tecken på bristande tydlighet. Om kommunikationen inte kan sammanfattas ordentligt på en enda sida är det en indikation på att produktchefen förmodligen bör gå tillbaka och bryta ner situationen ytterligare.
Formatering förbättrar kvaliteten. En dåligt strukturerad produktdokumentation ökar sannolikheten för att skribenten kommer att vifta med det. Skapa en mall med välformaterade avsnitt, tabeller och dokumentrubriker. Det är en engångsinvestering med hög utdelningspotential.
Mallar hjälper dig att spara tid. Det är mycket lättare att ta bort ett avsnitt från en mall än att komma ihåg att lägga till ett. Det är inte nedlåtande utan snarare effektivt och tidsbesparande. Enkla avsnitt som påminner skribenten om att börja med den breda bakgrunden och att vara specifik när det gäller mätningar eller farliga antaganden möjliggör ett mer precist skrivande och en mer exakt beslutshierarki.
Kommentera och tilldela uppgifter Det finns inget säkrare sätt att demotivera din personal från att producera högkvalitativ dokumentation än genom att inte kommentera dem. Kommentarerna behöver inte vara särskilt smarta, utan bör snarare visa på engagemang och tjäna som förebild. Även om det är idealiskt att ge feedback digitalt så att andra i företaget kan dra nytta asynkront av samtalet, fungerar en enkel funktion i Docsie som gör att du kan kommentera och samarbeta med ditt team produktdokumentationsteam utmärkt!
Kolla in den här bloggen för att lära dig mer om hur Docsie hjälper till med samarbete kring produktdokumentation.
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
Dokumenttyperna bör vara skalbara för att möta företagets krav. När fler intressenter blir involverade i produktutvecklingsprocessen måste kommunikationen delas upp på flera dokument (särskilt om kriteriet om en sidas kortfattadhet ska uppfyllas). Docsie möjliggör en användbar och hållbar lösning för växande produktdokumentationsteam.
Använd Docsie som ett sätt att påskynda skapandet av fantastisk produktdokumentation.
Docsie är en mycket praktisk plattform som hjälper dig med alla aspekter av skapandet av produktdokumentation och kunskapsportaler. Den har många inbyggda funktioner som gör det riktigt enkelt och roligt att skapa, publicera, underhålla och hantera projekt för skapande av produktdokumentation! Här är bara några av många av våra Docsies funktioner som kan hjälpa dig att uppnå dessa mål:
Möjlighet att redigera: Docsie gör det möjligt för alla våra användare att redigera produktdokumentation efter publicering genom att skapa en alternativ version som inte går live förrän den är aktiv. Detta är fantastiskt eftersom produkthanteringsteam kan arbeta med att redigera och ändra produktdokumentation och sedan göra den live när de är redo att göra det, utan att behöva hoppa igenom HTML- och CSS-hoppor. Produktdokumentationen kommer automatiskt att återges när de är redo.
Möjlighet att söka: Om din produktdokumentation är omfattande eller om det finns många funktioner är Docsies sökplugin en användbar bonus som gör det möjligt för dina kunder att snabbt och enkelt söka igenom din dokumentation för att hitta den information de behöver för att påskynda processen när de förhandsgranskar och tar till sig information från din produktdokumentation.
Möjlighet att länka: Docsie gör din produktdokumentation SEO-vänlig. Du kan länka tillbaka till vissa sidor på ditt företags webbplats eller bara skriva nyckelord baserade på dina produkter som kommer att vara sökbara online och locka nya kunder som vill hitta samma produkt som du har på plats.
Möjlighet till olika översättningar: Docsies toppmoderna spököversättare gör det möjligt för våra användare att översätta sin produktdokumentation till olika språk. Dessutom kan dina kunder med Docsies funktioner för språkval välja vilket språk som passar dem bäst. Detta är mycket användbart för global räckvidd och för att utöka företagens kundbas, samtidigt som man bygger upp förtroende med sina nygrundade kunder och kunder utomlands.
Möjlighet att tilldela uppgifter och kommentera för sömlöst samarbete: Docsie har fantastiska verktyg för samarbete med ditt produktdokumentationsteam. Du kan tilldela kommentarer, ställa in uppgifter och tilldela roller så att du bättre kan hantera vilka uppgifter som utförs av vilken användare som arbetar med ditt produktdokumentationsprojekt med Docsie. [Om du vill veta mer kan du kolla in den här bloggen här.] (https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/)
Feedbackgenerering: Att kunna veta vad dina kunder tycker om din dokumentation är det enda sättet att veta hur du ska optimera din produktdokumentation för att matcha dina kunders behov så att de kan förstå dina produktdokumentationer och kunskapsportaler på ett bättre sätt För att lära dig mer om vikten av feedback om produktdokumentation, kolla in min blogg här.
Det finns också många andra funktioner och möjligheter som Docsie låter dig och ditt produkthanteringsteam använda för att skapa fantastisk produktdokumentation. I den här artikeln vill jag hoppa in på plugins som varje Docsie kunskapsportal och produktdokumentation kan lägga till i sina dokumentationer för att förbättra dem och förbättra deras övergripande användbarhet.
Docsie-plugins för att göra din dokumentationsportal dynamisk Docsie har ett gäng plugins som du kan använda för att göra din dokumentation mer tilltalande. I den här bloggen kommer jag att dela upp den i tre delar.
I det här avsnittet kommer vi att dela upp förklaringen av dessa plugins för kunskapsportaler i tre delar.
DEL 1: I den första delen kommer vi att visa vad vi kommer att visa vad vi kommer att visa vad "Display Version Picker", "Display Language Picker", "Display Section Anchors" och "Display Footer Navigation" innebär.
DEL 2: I den här delen visar vi insticksprogrammen "Code Highlighting", "Search" och "Share to Social Network".
DEL 3: I del tre kommer vi att visa insticksprogrammet "Image Preview", "Document Metadata" och "Auto-highlight Section".
Innan vi går in på insticksprogrammen ska vi tala om hur du får tillgång till dessa insticksprogram i Docsie-plattformen.
Först måste vi i arbetsområdet klicka på de tre prickarna i det övre högra hörnet och öppna vårt konto:
Inom Deployments kan vi sedan få tillgång till plugins när vi skapar en ny deployment via "Configure a new deployment+" (konfigurera en ny deployment).
Klicka sedan på "More options" (fler alternativ) så att du kan lägga till dessa plugins i din distribuerade dokumentation via ett inbäddat skript eller via Docsie-portalen.
Det andra alternativet är att få tillgång till Docsies plugins för kunskapsportaler via knappen "Update deployment configuration" (uppdatera distributionskonfiguration) under din redan publicerade dokumentation.
Det kommer att öppna den här instrumentpanelen och du kan lägga till eller ta bort plugins som du vill och sedan uppdatera distributionen.
DEL 1:
Nu när vi vet hur vi får tillgång till Docsie Pluggin kan vi hoppa in i DEL 1.
För att se del 1 videohandledning kan du kolla in denna video här:
Låt oss börja med "Display version Picker" och "Display Language Picker".
När dessa två är aktiva kommer de att visas längst ner till vänster i din kunskapsportal som flytande flikar. De gör det möjligt för dina kunder och de som läser din produktdokumentation att se din produktdokumentation på olika språk och versioner.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_l5TJuQjEKYHFB1uKf/boo_NbQ7i8LYu6f7q4rnn/67756830-5264-edcc-cc47-ff4f83901882image.png)
När användaren trycker på Språk i språkväljaren ändras hela den dokumentation som han/hon läser till det tilldelade språket.
När ankaret Display Section (Visa avsnitt) är aktiverat kan din kund ha länkar bredvid varje rubrik som ger dem länkar till vissa avsnitt i dokumentationen.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_xfEuNCfFm3uRLsjgt/boo_NbQ7i8LYu6f7q4rnn/970f06ac-8fee-01f0-31fd-9b86800347aeimage.png)
Varje gång du trycker på dessa länkar kommer en del av rubriken att ändras och när din kund kopierar och skickar denna html-fil kommer den person som den skickas till att hänvisas till detta specifika avsnitt av dokumentationen.
Nästa är "Visa navigering i sidfoten".
Det här insticksprogrammet lägger till en navigeringsknapp längst ner till höger i din dokumentationsbok. Den ser ut ungefär så här.
På så sätt kan dina kunder lättare navigera i din dokumentation.
DEL 2:
För att se del 2 videohandledning, vänligen kolla in denna video här:
I den här delen kommer vi att visa insticksprogrammen "Code Highlighting", "Search" och "Share to Social Network".
Nu börjar vi med insticksprogrammet "Code Highlighting".
Detta plugin är perfekt för tekniska produkter som behöver uttrycka olika koder för sina kunder. Med detta plugin kan kunderna kopiera och klistra in den tilldelade koden så att de kan använda den i sin editor för att underlätta användningen genom att lägga till en "Copy"-knapp.
Låt oss nu dyka in i Search-pluginet.
När du har aktiverat din Docsie-kunskapsportal kan dina kunder söka i din dokumentation med hjälp av en söknavigering i det övre högra hörnet av kunskapsportalen.
Genom att klicka på sökning öppnas en sofistikerad instrumentpanel som gör det möjligt för dina kunder att exakt ange var de kan hitta viss information i dina hyllor och böcker.
Detta gör att dina kunder snabbare kan hitta och hämta den information om dina produkter som de behöver.
Nästa är insticksmodulen Dela till sociala nätverk
Med det här insticksprogrammet kan dina kunder ta del av markerade delar av din skriftliga produktdokumentation och dela den i sina sociala medier.
Detta är bra eftersom det kan öka trafiken, nya potentiella kunder och överlag förtroendet för ditt varumärke.
DEL 3:
För att se del 3 videohandledning kan du kolla in den här videon här:
I del tre kommer vi att visa insticksprogrammet "Image Preview", "Document Metadata" och "Auto-highlight Section".
Låt oss börja med pluginet för bildförhandsgranskning
Med förhandsgranskning av bilder kan dina kunder zooma in eller ut en bild av din produktdokumentation för att bättre kunna se den.
Nästa är "Metadata för dokumentation".
Detta gör att våra kunder kan se en tidsstämpel när produktdokumentationen eller delar av kunskapsportalen har uppdaterats. Den kommer att finnas högst upp och längst ner i den skriftliga dokumentationen.
Låt oss nu titta på insticksprogrammet "Auto-Highlight Section".
Med det här enkla insticksprogrammet kan dina kunder spåra var de befinner sig i en viss dokumentation i kunskapsportalen.
Det kommer att markera varje plats de befinner sig på i kunskapsportalen så att yo8ru-kunder bättre kan hålla reda på vilken sektion de befinner sig på och lättare navigera till andra sektioner.
Alla dessa verktyg och fler tillhandahålls av Docsie-plattformen. Om du inte har provat den föreslår vi att du gör det. [Klicka här] (https://app.docsie.io/try/t/)
Om du har några frågor är du också välkommen att kontakta oss på hello@docsie.io.