Välja programvara för att göra online -dokumentation

Vilken programvara behöver du för att skapa en mängd onlinedokumentation 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 fullvärdig miljö) behöver du enkelt skapa onlinedokumentation.

göra online -dokument

Coworking Miljö

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

Alla ska känna sig bekväma i en enhetlig molnmiljö. Det finns olika funktioner som kan göra en molntjänst med lagring och en redigerare till denna typ av miljö:

  •     En inbyggd budbärare. Alla borde hålla kontakten. Med en sådan budbärare kan du skicka interna länkar, skärmdumpar, händelser i företagskalendern och så vidare. Uppgifterna du skickar förblir säkra.
  •     Schemaläggningsverktyg. Du måste utse händelser, tilldela uppgifter, övervaka deras status, ställa in tidsfrister, överföra uppgifter till andra specialister (om det behövs), kontrollera hur upptagna de är och så vidare.
  •     Anpassningsbart arbetsflöde. Det kan finnas olika uppgifter som kräver olika team och olika tillvägagångssätt.

Det är också viktigt att göra denna tjänst över plattformen, särskilt i vår lockdown-tid när allt går fjärran. De anställda tar inte bara 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 redaktör och allt som behövs.

Konfigurerbara redaktörer

När det gäller onlinedokumentation för programvara kommer oundvikligen riktlinjerna fram som definierar resultatet. Några av dem dikteras av ren användbarhet, andra kommer från programvaruspecifika funktioner, och ibland är det ett krav att behå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 ta bort från redaktörer? Vissa formateringsalternativ och teckensnitt 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 kodvisning eller må bra med en rent visuell redigerare. Slutligen kan du skapa olika versioner av redigeraren, beroende på position. Tekniska författare, säg, har bara tillgång till grundversionen, 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 på 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. Naturligtvis är dokumentation främst 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 som kan anpassas ä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 kan du behöva 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 dokumentationen enkel. Men det är viktigt 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 innehålla:

  •     Hosting för din dokumentation. Naturligtvis bör det ge tillräckligt med utrymme och bekväm integration på din huvudsida.
  •     Live chatt. Om en kund har en fråga att ställa bör de kunna ställa den direkt från sidan där den kom fram eller från den mest relevanta.
  •     Varningar. När den nya versionen kommer ska du meddela kunderna om den.
  •     Exportbarhet. Online -dokumentation ä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 för din egen server.
  •     Tredjeparts integrering av tjä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 kommentarsplattformar från tredje part. 

Priser

Knappt kan det finnas något bättre som passar SaaS -modellen än programvara för att skapa dokumentation online. Molnbaserat per definition, det erbjuder mer än bara dokumentskapande verktyg. Med redaktörerna kommer fördelar 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 också i flexibilitet. Du kan spara mer om du bara prenumererar på de funktioner du verkligen behöver.

Dokument

Online dokumentation är effektivare än lokala statiska dokument, men det kräver mer ansträngning att skapa och underhålla. Inte konstigt att verktygen för det är speciella också. Men ju tydligare du föreställer dig 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 när din produkt utvecklas. I hela sortimentet av dokumentationsskapande programvara finns det ett verktyg för dig.