Välja programvara för att göra onlinedokumentation

0 Shares

Vilken programvara behöver du för att skapa onlinedokumentationen för din produkt? Det finns ett brett utbud av professionella verktyg som tillgodoser behoven för denna specifika uppgift. Clickhelp.com är ett exempel på sådan programvara (och ännu mer, på en fullfjädrad miljö) som du behöver för att skapa onlinedokumentation med lätthet.

göra onlinedokument

Coworking miljö

Det räcker med att installera OpenOffice.org eller en av dess många free alternativ för att skapa dokument ensamma på din lokala dator. Men när det kommer till en enorm mängd teknisk dokumentation för ett stort projekt kräver det mycket mer. Även om du bara hanterar ett projekt, finns det för det första flera skribenter och designers som ansvarar för olika delar av dokumenten. För det andra finns det recensenter och redaktörer som övervakar författarnas arbete. För det tredje finns det utvecklare av själva mjukvaran som måste hålla kontakten med dokumentationsavdelningen. Om projektet är flerspråkigt (vilket är logiskt för en global produkt) behövs också översättare. Slutligen finns det chefer som styr processerna.

Alla ska känna sig bekväma i en enhetlig molnmiljö. Det finns olika funktioner som kan förvandla en molntjänst med lagring och en editor till den här typen av miljö:

  • En inbyggd messenger. Alla borde hålla kontakten. Med en sådan messenger kan du skicka interna länkar, skärmdumpar, händelser i företagskalendern och så vidare. Datan du skickar förblir säker.
  • Schemaläggningsverktyg. Du måste utse evenemang, tilldela uppgifter, övervaka deras status, sätta deadlines, omfördela uppgifter till andra specialister (vid behov), kontrollera hur upptagna de är och så vidare.
  • Anpassningsbart arbetsflöde. Det kan vara olika uppgifter som kräver olika team och olika förhållningssätt.

Det är också viktigt att göra den här tjänsten plattformsoberoende, speciellt i vår lockdown-era när allt går på distans. Nu tar inte bara medarbetarna med sig sina egna enheter: de arbetar hemifrån med vad de har eller anser nödvändigt. Så onlineverktygen måste vara tillgängliga via alla de mest populära webbläsarna för Windows, Mac eller Linux. Det kan finnas en mobilapp som kombinerar en budbärare, en kalender, en anpassningsbar redigerare och vad som helst som behövs.

Konfigurerbara redigerare

När det kommer till onlinedokumentation för programvara, dyker oundvikligen riktlinjerna upp som definierar resultatet. Vissa av dem dikteras av ren användbarhet, andra kommer från mjukvaruspecifika funktioner, och ibland är det ett krav att hålla dokumenten utformade i din företagsstil. För att göra din dokumentation enklare och snabbare kan du bara välja de verktyg du behöver för att göra den.

Vad kan du överlämna från redaktörer? Vissa formateringsalternativ och typsnitt kan vara överflödiga. De mest nödvändiga funktionerna kan placeras framför de andra, så de är lättast att komma åt. Teckensnitten visas i frekvensordning, så de mest efterfrågade kommer först. Du kan behöva byta till kodvy eller må bra med en rent visuell redigerare. Slutligen kan du skapa olika versioner av editorn, beroende på befattning. Tekniska skribenter har till exempel bara tillgång till den grundläggande versionen, medan redaktörer och chefer kan redigera sidor med en större pool av verktyg.

Mallar

Du kan överväga att designa dokument från början det enda sättet. Ändå kan mallar spara tusentals timmar med det faktum att de finns. En bra mall kan behöva väldigt få ändringar för att passa dina krav och se ut som du vill ha den. Självklart är dokumentation i första hand funktionell, med lite utrymme för designers experiment. Ändå finns det tillräckligt med frihetsgrader.

Det kan inte bara finnas mallar för dokumentationsportalsidor. Det kan finnas redaktörskonfigurationer, arbetsflödesmallar och så vidare. Allt anpassningsbart är bättre med ett par exempel.

Mallar är faktiskt bara en del av en struktur på flera nivåer. Om du vill skapa din dokumentation snabbt måste du kunna göra det på några minuter med mallar, importverktyg och snabbredigerare. Men om du vill anpassa det djupare, kanske du behöver mer professionella verktyg, så att du kan redigera och justera både innehållet och användbarheten.

Slutlig användbarhet

Det är viktigt att göra det enkelt att skapa dokumentation. Men det är avgörande att göra den färdiga dokumentationen enkel att använda för kunderna. Så programvaran (eller snarare tjänsten) du använder bör stödja funktioner som förbättrar användbarheten. De kan inkludera:

  • Hosting för din dokumentation. Det behöver inte sägas att det ska ge tillräckligt med utrymme och bekväm integration på din huvudwebbplats.
  • Livechatt. Om en kund har en fråga att ställa bör de kunna ställa den direkt från sidan där den dök upp eller från den mest relevanta.
  • Varningar. När den nya versionen kommer bör du meddela kunderna om det.
  • Exporterbarhet. Onlinedokumentation är bra, men om din kund vill ha en lokal kopia bör de kunna ladda ner en CHM-version, en PDF-fil eller en webbhjälp för att vara värd på din egen server.
  • Integrering av tredjepartstjänster. Om du planerar att sälja din produkt globalt kan du integrera automatisk översättning. Om kommentarer förutses kan du lägga till Disqus eller andra tredjepartskommentarplattformar.

Prissättning

Det finns knappast något som passar SaaS-modellen bättre än mjukvara för att skapa onlinedokumentation. Molnbaserad per definition erbjuder den mer än bara verktyg för att skapa dokument. Med redaktörerna kommer förmåner som en inbyggd messenger, hanteringsverktyg, molnlagring för dokument och sånt. Inte konstigt att dess underhåll gör prenumeration till det mest logiska alternativet.

Ändå finns det olika betalningsalternativ, inte bara i belopp utan även i flexibilitet. Du kan spara mer om du bara prenumererar på de funktioner du verkligen behöver.

Dokument

Onlinedokumentation är effektivare än lokala statiska dokument, men det kräver mer ansträngning att skapa och underhålla. Inte konstigt att verktyg för den är speciella också. Men ju tydligare du ser bilden av din framtida dokumentationsportal, desto lättare blir det för dig att hitta rätt programvara för att utveckla och underhålla den i takt med att din produkt utvecklas. I hela utbudet av programvara för att skapa dokumentation finns det ett verktyg för dig.

0 Shares