Digital dokumentation: Bästa praxis för att informera och inspirera

Avatar of Author
Tal F
on May 04, 2021 · · filed under Product Documentation Best Practices

Från papper till pixlar

För bara några årtionden sedan verkade det som om alla företag använde papper för dokumentation. Kontrakt, policyer, mötesanteckningar - allt var pappersbaserat och skrevs ut och skickades runt i stället för att bifogas och analyseras via e-post.

I takt med att tekniken blev mer avancerad fick företagen mer lagringsutrymme för dokumentation och de datorsystem som behövdes för att de anställda skulle få tillgång till dessa digitala dokument. Detta markerar början på en övergång från papper till pixlar.

Den moderna världen med digital dokumentation erbjuder många fördelar, men problemen kvarstår. Dokumentation används för att förmedla information, både till intern personal och externa kunder. Detta innebär att det är viktigt att innehållet är konsekvent, att det är lätt att komma åt och att det är lätt att hantera. Inkonsekvent, otillgänglig och svårhanterlig digital dokumentation kan däremot minska företagets förmåga att effektivt förmedla information.

För att underlätta och skapa konsistens bör företagen följa bästa praxis för digital dokumentation. Detta omfattar utformning, formatering, val av filtyper och förvaltning av digital dokumentation.

I den här e-boken kommer vi att diskutera bästa praxis för digital dokumentation och de potentiella affärseffekterna av att göra dessa förändringar. Kan bättre digital dokumentation driva på intäktstillväxten och locka till sig kunder? Hur kan företag omvandla sin digitala dokumentation för att leverera bättre värde till kunderna med hjälp av ett dokumentationshanteringssystem, DMS?

Låt oss besvara dessa frågor!

Fördelar med digital dokumentation

Innan vi diskuterar vad och hur bästa praxis för digital dokumentation ska vi först förstå fördelarna med digital dokumentation:

  • Enklare hantering -- Digital dokumentation är lättare att hantera än pappersdokument. Pappersdokumentation kräver utrymme på kontoret för ett arkivskåp och manuell arkivering av varje pappersdokument. Digital lagring av dokument frigör kontorsutrymme och förenklar hanteringen med sökfunktioner och mappstrukturer.

Som framgår av denna studie från Software Advice spenderar kontorsarbetare i genomsnitt sex timmar per vecka på att leta efter pappersdokument. Dessutom spenderar kontorsarbetarna i genomsnitt åtta timmar i veckan på att skapa rapporter från pappersdokument, och 94 % säger att ett dokumenthanteringssystem (DMS) underlättar denna process.[1]

  • Lättåtkomlighet - Dessa digitala dokument kan också delas, praktiskt taget i realtid, via e-post eller molnlagring. Detta gör att man inte behöver posta brev, vilket eliminerar porto- eller kurirkostnader. Det ökar också svarstiden, eftersom mottagarna inte längre behöver vänta i flera dagar på att ett brev ska komma fram. Dessutom kan digital dokumentation läggas ut på din webbplats eller sociala medier, vilket gör det lättare för kunderna att komma åt den.

Visste du att - enligt Gartner - för varje 1 dollar som spenderas på att skriva ut dokument, spenderas ytterligare 6 dollar på att hantera och distribuera dessa dokument? Dessutom slängs hälften av alla tryckta dokument inom 24 timmar.[[2]]](file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn2)

  • Säkerhet och styrning -- Pappersdokumentation är osäker om den inte är gömd bakom ett lås och en nyckel. Vem som helst kan läsa den, göra en kopia och dela med sig av den. Digital dokumentation kan däremot styras med hjälp av rollbaserad åtkomstkontroll (RBAC) så att endast de som behöver den får tillgång till den.

Till och med regeringar är inte immuna mot dataintrång i pappersformat, och enligt det amerikanska ministeriet för veteranfrågor är pappersdokumentation orsaken till 98 % av dataintrången[[3]]](file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn3).

  • Miljöfördelar -- Både människor och företag letar efter sätt att minska sitt miljöavtryck. Digital dokumentation är en av de vägar de kan gå. Enligt Green America har pappersförbrukningen ökat med 400 % under de senaste 40 åren och industrin står för 4 % av den globala energiförbrukningen[[4]] (file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn4). Genom att välja digital dokumentation kan företagen minska sin pappersanvändning för att bekämpa avskogning - och hålla träden vid liv för att absorbera koldioxidutsläpp och bevara livsmiljöer för djur.

Bästa metoder för digital dokumentation på Docsie

Digital dokumentation kan förändra kunskapsdelning, publicering och marknadsföring i hela företaget. För att utnyttja denna potential bör företag följa bästa praxis för digital dokumentation:

Anpassa DMS till företagets behov

Ett dokumenthanteringssystem (DMS) är grunden som hjälper företag att lagra och hantera sin dokumentation. När innehållet är skrivet laddas det upp till ett DMS för lagring och distribution. Ett DMS centraliserar dokumentationslagringen och ger en enda kunskapskälla för hela verksamheten. Det fungerar ungefär som ett digitalt bibliotek, där dokumenten kategoriseras efter avdelning eller produkt, med sökfunktionalitet för att effektivisera kunskapsdelningen. Härifrån kan marknadsförings- och supportteam dela dokumentation och publicera den på webbplatser och sociala medier eller som svar på kundförfrågningar.

Docsie är ett DMS som förenklar hur ditt team hanterar dokument. Alla företag behöver ett sätt att lagra och dela dokumentation, både så att intern personal kan lära sig mer om sin arbetsroll och så att kunderna kan lära sig att använda din produkt eller tjänst. Inskolningsdokument för personal, produkthandböcker, mallar för säljkommunikation - allt detta kan lagras och publiceras med rätt DMS-lösning.

Vilken dokumentation finns för närvarande om dina produkter och tjänster? Använder din personal mallar och ramar när de kommunicerar med kunderna? Kan ni enkelt lagra, dela internt och publicera er dokumentation externt? Ställ dessa frågor när du överväger en DMS-lösning som Docsie, och se till att din DMS är anpassad till verksamhetens behov.

Fokusera på kompatibilitet

Digital dokumentation kan öka tillgängligheten, men endast om man använder mycket kompatibla filformat. Detta är viktigt när det gäller nedladdningsbar dokumentation, eftersom vissa kunder kanske inte kan öppna en fil. Det gäller även intern dokumentation, där en anställd som använder PDF och en annan som använder DOCX kan orsaka fragmentering av filformatet, vilket gör att andra anställda måste byta programpaket eller konvertera till ett annat format för att göra filen tillgänglig.

Öppna filformat som docx, xlsx och pptx för Microsoft Office eller det öppna dokumentformatet (ODF) för OpenOffice är idealiska för att maximera kompatibiliteten. Adobe PDF-dokument är vanliga, men mindre kompatibla eftersom de kräver en PDF-läsare. Tänk på vem som kommer att få tillgång till dokumenten och lagra dokumentationen i ett format som passar så många användare som möjligt.

Docsie är ett utmärkt alternativ för bred dokumentkompatibilitet. När text laddas in i Docsie Book Editor lagras den i filformatet JSON (JavaScript Object Notation) med öppen källkod. Du hittar mer information om export av dokument och hur Docsie möjliggör enkel konvertering till DOC-, PDF-, Markdown- (MD) och HTML-format [här] (https://portals.docsie.io/docsie/docsie-documentation/using-docsie/?doc=/docsie-editor/exporting-content/).

Feedback som kan åtgärdas

Feedback från användare och anställda om dokumentationen är viktig. Om dokumentationen saknar information, innehåller felaktig information eller helt enkelt är svår att läsa kommer läsarna att ha svårt att få ut något värde av dokumentationen. Dessutom kan feedback hjälpa dig att förbättra den befintliga dokumentationen så att den ger kunderna ett större värde, vilket leder till affärsmässiga framgångar genom kunskapsdelning av hög kvalitet.

Docsie Vocally är en allt-i-ett-tjänst för övervakning och svar på feedback. Den gör det möjligt för läsarna att rangordna enskilda delar av dokumentationen på en skala från ett till fem, med kommentarer för att förklara skälen till deras betyg. Docsie-ägare och administratörer kan läsa denna feedback och på så sätt få en inblick i hur framgångsrik och bristfällig din dokumentation är.

Kunskapsdatabaser med självbetjäning är utformade för att minimera kraven på support, men detta innebär också att kunderna sannolikt inte kommer att fortsätta med dålig dokumentation - istället söker de efter ett alternativ hos konkurrenter som tillhandahåller bättre dokumentation. För att lösa detta problem registrerar Docise Vocally användarnas interaktioner när de läser din dokumentation. Detta kommer att belysa var de stött på ett problem i ett dokument och vilket innehåll som orsakar problemet. Skribenterna kan använda den här feedbacken för att redigera dokumentationen och agera på användarnas feedback. Med tiden kommer detta att förbättra kvaliteten på kunskapen om dokumentationen och ge kunderna möjlighet att hjälpa sig själva.

Kundinflytande är ett utmärkt sätt att locka till sig nya affärer, minska kostnaderna och behålla kunderna. Omkring 67 % av kunderna föredrar självbetjäning framför att tala i telefon, enligt Zendesk[[5]]](file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn5). Forrester Research och Oracle har också konstaterat att självbetjäning kan sänka supportkostnaderna med 11 dollar per samtal[[6]] (file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn6). I en undersökning från Microsoft framhålls slutligen att 90 % av kunderna förväntar sig ett självbetjäningsalternativ[[7]]](file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn7).

Sammanfattningsvis föredrar och förväntar sig kunderna högkvalitativ självbetjäning, och genom att erbjuda detta alternativ kan supportkostnaderna minskas avsevärt. Genom att skapa en kunskapsdatabas för självbetjäning i Docsie och förbättra dokumentationskvaliteten med hjälp av feedback via Docsie Vocally kan du tillgodose kundernas krav genom digital dokumentation. Läs mer om Docsie Vocally [här] (https://www.docsie.io/vocally/).

Dokumentversionering

Särskilt i teknikföretag kan nya programvaru- eller tjänsteversioner skapa problem med dokumentationen. Den nya versionen kan innehålla andra arbetsflöden än tidigare versioner eller annan terminologi som kan förvirra användarna. Samtidigt kan det hända att den nya dokumentationen inte gäller för äldre versioner av dina tjänster, vilket skapar kunskapsluckor som kan leda till frustration och att kunderna blir bortkörda.

Detta är en viktig bästa praxis när det gäller digital dokumentation. Kunderna kan behöva äldre versioner av din programvara för att vara kompatibla med sin hårdvara, eller helt enkelt välja att inte uppdatera till en ny version. Därför bör företag alltid tillgodose sin användarbas oavsett vilket versionsnummer som används.

Docsie tar itu med detta problem med versionering av dokument. När du uppdaterar ett dokument i Docsie kan du behålla tidigare versioner i redundanssyfte. Kunder med version 2 av din tjänst kan välja rätt dokumentation, medan kunder med version 1 fortfarande har tillgång till äldre dokumentation. Detta kallas fragmentering; när din kundbas är uppdelad på flera versioner av samma programvara. Docsie minskar effekterna av fragmentering och ser till att kunskapen är tillgänglig oavsett vilken version som används.

Versionering av dokument säkerställer att rätt information finns tillgänglig när den behövs. Det underlättar också spårbarheten, särskilt när flera skribenter arbetar med samma innehåll. Versionering minskar också dubbelarbete och konsoliderar dokumentationen så att den blir lättillgänglig.

Uppdaterar ditt företag regelbundet sin dokumentation? Har dina kunder svårt att hitta rätt information för aktuella och tidigare versioner av dina programvaror och tjänster? Om så är fallet kan det vara dags att tillämpa bästa praxis för versionering av dokument genom ett DMS som Docsie. Du hittar mer information om Docise dokumentversionering [här] (https://portals.docsie.io/docsie/docsie-documentation/using-docsie/?doc=/docsie-editor/managing-versions/).

Dokumentationsvanor hos personalen

Dina medarbetare skapar dokumentation, men de kan också skapa problem med dokumentationen. Under utkastfasen kan skribenterna använda olika typsnittsstorlekar eller typsnittstyper, eller föråldrad ikonografi och konstverk. Dessa skillnader är lätta att missa för anställda som arbetar med innehåll varje dag, men kunderna är mer benägna att lägga märke till dem. Resultatet blir inkonsekvent dokumentation, som drivs av inkonsekvenser i tillvägagångssättet för innehållsskapande och publicering i hela din personalstyrka.

Docsie hjälper företag att ta itu med innehållsinkonsistens med Docsie Documentation Hub. Du kan ställa in en standardtypsnittstyp och -storlek, lägga till företagslogotyper eller konstverk och definiera CSS-stilarkparametrar för användning på en företagswebbplats eller kunskapsdatabas. Dessa val kommer att spridas från Docsie till alla webbsidor med inbäddat innehåll från Docsie, med samma färger, typsnitt och logotyper överallt där ditt innehåll publiceras.

Detta förenklar innehållshantering och arbetsflöden för publicering. I stället för att redigera enskilda sidor kan företag ställa in en ram för innehållsdesign en gång i Docsie och tillämpa dessa ändringar överallt. Detta kallas centraliserad hantering eller orkestrering. Processen att redigera varje dokument eller sida individuellt kan verka genomförbar för mindre innehållsbibliotek, men denna process kommer inte att skalas effektivt när biblioteket växer i bredd och djup.

Sammanfattningsvis arbetar Docsie för att framtidssäkra dina arbetsflöden för innehållshantering genom att minimera den administrativa arbetsbördan på låg nivå. Genom att börja med skalbarhet i åtanke kan stora innehållsbibliotek hanteras med enkelhet - genom att ställa in ramarna för innehållsdesign en gång och distribuera överallt med Docsie. Du kan läsa mer om Docsie Customized Documentation Hubs med hjälp av Docsie Manager [här] (https://www.docsie.io/docsie_manager/).

Centraliserad lagring av dokumentation

När det gäller centralisering kan dokumentlagringsplatser hjälpa eller hindra arbetsflöden för hantering och publicering. Du kan lagra dokumentation på ett intranät eller en SharePoint-webbplats, i Dropbox eller Google Drive, och på plats eller i molnlagringspartitioner. Varje alternativ här fungerar isolerat, men kan orsaka kaos när det används samtidigt.

En anställd behöver tillgång till ett dokument. Dokumentet lagras på en SharePoint-webbplats. Den anställde laddar ner det och sparar det på sin kontolagringspartition. Ett verktyg för synkronisering av företagsfiler laddar upp detta till molnet automatiskt. Den anställde skickar dokumentet via Slack till en kollega. Det är fyra kopior av samma dokument som cirkulerar i ditt IT-nätverk, med decentralisering över fyra olika tjänster eller verktyg.

Docsie tar itu med detta decentraliserade kaos genom att centralisera dokumenten på en enda lagringsplats. När du laddar upp ett dokument placerar Docsie dokumentet på en hylla. Vi hänvisar till dokumenten som böcker, där varje hylla fylls med böcker för att bilda ett innehållsbibliotek. Anställda kan logga in på Docsie för att hitta all din dokumentation, med filtrering som levererar relevant dokumentation efter avdelning eller tjänstgöringsgrad med hjälp av rollbaserad åtkomstkontroll (RBAC). Härifrån kan de anställda publicera dokument direkt på din webbplats, redigera dokumentationstext, kontrollera olika versioner och se feedback från kunder eller kollegor.

När en anställd nu behöver tillgång till ett dokument behöver de bara öppna Docsie. De kan söka efter dokument, exportera i vanliga filformat och dela direktlänkar till Docsie-böcker eller -hyllor. Externa användare kan bjudas in av ägare och administratörer för direktåtkomst till auktoriserade Docsie-böcker och -hyllor, utan att kompromissa med säkerheten. Det är som mappar och filer på en hårddisk, men med lite Docsie-magi! Du kan läsa mer om Docsie-hyllor och -böcker [här] (https://www.docsie.io/features/).

Dokumenthantering Risk och efterlevnad

Den mesta dokumentationen kommer att skapas för den offentliga sfären. Vissa dokument kan dock vara konfidentiella. Detta innebär ett behov av hantering av styrning, risk och efterlevnad (GRC). GRC-policyer kan användas för att styra tillgången till konfidentiella dokument, kontrollera dokumentbehörigheter för författare och läsare och förhindra oavsiktlig publicering av dokumentation i utkastfasen.

Docsie använder rollbaserad åtkomstkontroll (RBAC) för att styra behörigheter på plattformen. På så sätt hjälper Docsie företag att hantera GRC-arbetsflöden, genom att definiera användarroller och tilldela behörigheter baserat på senioritet eller avdelning. Dessa roller inkluderar Viewer, Editor, Admin och Owner. Betraktare får endast läsbehörighet till dokumenten, medan redaktörer får läs- och skrivbehörighet. Administratörer kan tilldela roller för att hantera vem som får läsa, skriva eller både och per bok eller per hylla. Ägaren kan hantera alla användare och dokument i en Docsie-organisation och är den enda användarrollen som kan radera en hel organisation. I det här exemplet kan organisationen vara Docsie, med hyllor som innehåller böcker om olika funktioner i Docsie.

Sammanfattningsvis är GRC viktigt för att hantera tillgången till dokumentation. Med för liten tillgång kommer de anställda inte att kunna arbeta med dokumentation. Med för mycket åtkomst kan anställda av misstag publicera oavslutad dokumentation eller få tillgång till konfidentiella dokument som är reserverade för chefer och ledare. Docsie hjälper dig att hitta en balans mellan åtkomst och säkerhet, vilket gör plattformen lämplig för lagring av alla typer av dokument.

Det här dokumentet är känsligt, hur kan jag förhindra obehörig åtkomst? Hur kan jag ge mitt team skrivbehörighet medan andra team endast får läsbehörighet? En frilansskribent behöver tillstånd att redigera det här dokumentet, hur kan jag göra det? Om ditt företag ställer sig dessa frågor har Docsie svaren! Du hittar mer information om Docsie-behörighetshantering [här] (https://portals.docsie.io/docsie/docsie-documentation/using-docsie/?doc=/workspace-administration/managing-and-understanding-permissions/).

Samarbete i team

Innehållet utformas sällan av en enda person. När flera skribenter arbetar med ditt dokumentationsbibliotek är samarbete viktigt.

Vilka processer följer dina anställda när de arbetar med dokumentation? Ett exempel är att söka på en nätverksenhet efter befintliga dokument och ladda ner dem till en dator. Därefter kan skribenten skicka ett slututkast via e-post till en kollega för ytterligare granskning. Det godkända utkastet kan sedan laddas upp till ett innehållshanteringssystem (CMS) redo för publicering. Senare under dagen upptäcker någon ett problem och skickar en kommenterad version tillbaka till skribenten via Slack. Detta arbetsflöde kan fungera, men det kan förenklas.

Docsie minskar antalet verktyg du behöver med omfattande funktioner för teamsamarbete. Du kan hitta dokument i Docsie, skriva och redigera, dela ändringar med teammedlemmar, chatta och kommentera och publicera på internet utan att någonsin lämna Docsie-instrumentpanelen. Detta gör att du inte behöver ladda ner, ladda upp, skicka e-post och hantera ett CMS - du kan helt enkelt hantera dina dokument med Docsie! Teammedlemmar kan märkas med @mention, chattkonversationer är isolerade till varje Docsie-bok och externa frilansare kan enkelt bjudas in för fullt teamsamarbete var som helst.

Genom att minimera antalet nödvändiga verktyg kan medarbetarna fokusera på att skapa innehåll istället för att byta mellan olika programvaror. Detta påskyndar arbetsflöden för innehållsskapande genom att minimera bortkastade klick, och kommentarer och förslag från kollegor är lätt tillgängliga i verktygsfältet till höger. Ingen mer länkdelning, inga mer föråldrade versioner av dokument, inga mer förlorade e-postmeddelanden eller chattmeddelanden - allt som har med dina dokument att göra är centraliserat i Docsie.

Tillämpa bästa praxis på dina dokument med Docsie

I takt med att vi går från papper till pixlar är det viktigt med god dokumenthantering. Genom att tillämpa de här bästa metoderna för digital dokumentation kan företag skapa och dela kunskap som ger kunderna ett verkligt värde, samtidigt som de effektiviserar arbetsflödena för innehåll och minskar kostnaderna. Den enda frågan är hur du tillämpar dessa bästa metoder.

Det är där Docsie kommer in i bilden. Docsie bygger på dessa bästa metoder för dokumentation och tillämpar dem automatiskt för att effektivisera arbetsflöden för skapande, hantering och publicering av innehåll. Plattformen är utformad för att fungera med alla typer av dokumentation och överensstämmer nära med typiska DMS-krav för företag. Vid import och export använder Docsie-dokumentationen öppna och kompatibla filformat för att öka tillgängligheten. Företag kan läsa och agera på feedback om kunddokumentation med hjälp av Docsie Vocally, vilket förbättrar kunskapskvaliteten och minskar innehållsfel. Dokumentversionering gör det möjligt att behålla historiska versioner för att bevara information. Ramar för varumärkes- och innehållsdesign kan ställas in en gång och tillämpas överallt med Customized Documentation Hub. Allt lagras på en plats - Docsie-portalen - så att de anställda snabbt kan hitta ett dokument i stället för att behöva söka på datorn, molndisken eller i e-post. Behörigheter kan ställas in för att hantera GRC, vilket förhindrar obehörig åtkomst till känsliga dokument. Slutligen kan kollegor chatta, dela, länka, bifoga och ge åtkomst till entreprenörer för centraliserat teamsamarbete på Docsie.

Skapa dokumentation som dina kunder kommer att älska, utan komplexiteten. Om ditt företag letar efter en DMS-lösning kan du överväga att ge Docsie ett försök! Det är bara att [ta kontakt] (https://www.docsie.io/discovery_call/) med vårt säljteam, som gärna visar dig en 15-minuters demonstration av Docsie-plattformen.


[1] https://www.softwareadvice.com/cms/industryview/go-paperless-with-document-management-software/

[2] https://www.stopwaste.org/at-work/reduce-and-reuse/reduce-paper-use/the-impact-of-paper-waste#2

[3] https://fcw.com/articles/2013/08/08/va-data-breaches.aspx

[4] https://www.greenamerica.org/sites/default/files/inline-files/Paper%20Facts%202017.pdf

[5] https://www.zendesk.com/blog/searching-for-self-service/

[6] https://www.slideshare.net/UniWeb/the-total-economic-impact-of-click-to-call-and-click-to-chat

[7] https://download.microsoft.com/documents/en-us/dynamics/Global_State_of_Multichannel_Customer_Service_Report.pdf.pdf


Subscribe to the newsletter

Stay up to date with our latest news and products