Att skriva mjukvarudokumentation spelar en viktig roll i en programmerares arbete. Som de säger, om den inte är dokumenterad så finns den inte, och i de flesta fall är det lika viktigt att dokumentera din kod på ett korrekt sätt som att faktiskt skriva den. "Oavsett hur underbart ditt bibliotek är och hur intelligent dess design är, om du är den enda som förstår det, gör det ingen nytta. Dokumentation innebär inte bara autogenererade API-referenser, utan också kommenterade exempel och djupgående handledningar. Du behöver alla tre för att se till att ditt bibliotek lätt kan adopteras”, säger Nicholas Zakas, en välkänd frontendingenjör och bokförfattare. Det är därför vi idag bestämde oss för att ta en titt på några av de bästa och mest använda verktygen för mjukvarudokumentation och tekniskt skrivande.
Hjälp författarverktyg
Hjälp författarverktyg spelar en viktig roll i programvarudokumentation och tekniskt skrivande, eftersom de gör det mycket lättare att designa, skriva, publicera och underhålla programvarudokumentation. De tillåter dig att minska tid och ansträngning som behövs när du skapar alla typer av hjälpmaterial både för slutanvändare och andra programmerare/anställda.
MadCap Flare är ett av de mest populära hjälpskrivarverktygen tack vare dess rika urval av funktioner som låter dig göra mycket mer än att bara skriva hjälpdokumentation. MadCap Flare designades för avancerad ämnesbaserad författarskap, publicering med en källa och innehållshantering. Det låter dig skapa hjälp- och kundsupportwebbplatser, vanliga frågor, kunskapsbaser, onlineutbildningscenter, guider, policy- och proceduremanualer och mer. MadCap Flares funktioner gör det lättare att återanvända samma innehåll i flera kanaler och publicera det snabbt över en rad plattformar.
Document360 är en annan mycket använd webbplattform som låter dig bygga, publicera och uppdatera alla typer av kunskapsbaser och hjälpmaterial. Den har också flerprofilsfunktionalitet, inklusive en enkel Markdown-textredigerare, Category Manager för att bygga kunskapsbasstrukturen, målsidesanpassningsfunktioner, versionsåterställning, säkerhetskopiering och återställning, flexibla roller och behörighetsjusteringar och så vidare.
Adobe RoboHelp är ett annat kraftfullt alternativt hjälpskrivarverktyg, som erbjuder ett lite annorlunda urval av funktioner jämfört med MadCap Flare och Document360. I synnerhet erbjuder Adobe RoboHelp enkel publicering i flera format, vilket gör att du kan publicera innehåll till ett brett utbud av populära utdataformat, inklusive Frameless Responsive HTML5, PDF, Microsoft Help (CHM) och ännu mindre vanliga format som EPUB 3, KF8 och MOBI.
Help+Manuals stora fördel är dess enkla gränssnitt som gör det mycket tillgängligt och lätt att använda, tillsammans med full funktionalitet av en WYSIWYG XML-redigerare, flerkanalspublicering, fullt stöd för multimedia och komplexa modulära projekt, Webhelp-verktyg för sömlös integrering av dokumentation till aktiva webbplatser och så vidare.
ClickHelp tillhandahåller också en ganska kraftfull webbplattform för programvarudokumentation i form av kunskapsbaser, vanliga frågor, handledningar och andra hjälpformat. Stöder flera format som Word, HTML, RTF, CHM, ODT, CHM, HTML5 Web Help, PDF, DOCX, etc. Vissa av ClickHelps signaturfunktioner är patenterad fulltextsökning som gör det lättare att hitta specifika ämnen eller artiklar både för författare och användare, samt ett urval av flera förbyggda mallar för dokumentationsdesignen.
Skärminspelningsverktyg
De flesta programvarudokumentation och hjälpmaterial måste inkludera skärmdumpar, så det skulle vara vettigt att göra en kort översikt över de bästa skärmdumpsverktygen som finns.
Om du använder Windows som ditt operativsystem kommer det med ett klippverktyg, som låter dig göra skärmdumpar av hela skärmen, separata fönster eller en del av skärmen och använda pennverktyget för att markera vissa specifika delar av skärmdumpen.
FireShot är ett populärt webbläsarplugin som stöder i stort sett alla moderna webbläsare som Chrome, Firefox, Internet Explorer och Opera. Låter dig fånga hela webbsidan eller någon specifik del av den.
SnagIt är ett mer komplext skärmdumpsverktyg. Det låter dig fånga rullande områden på vilken sida som helst, samt stödja videoinspelning. Du kan också använda den här bilden för att skapa GIF:er och spela in specifika uppsättningar av åtgärder på skärmen.
Stavnings- och grammatikkontroll
Det är också viktigt att se till att din dokumentation är korrekt skriven utan grammatik och skiljetecken. Här är några av verktygen som hjälper dig att hitta fel i dina texter och åtgärda dem.
En av de mest populära gratis stavnings- och grammatikkontrollerna online. Skrivare kan identifiera och korrigera över 250 olika typer av misstag, inklusive substantiv, pronomen, prepositioner, verb, homonymer, skiljetecken, typografi och så vidare.
Som ett tillägg till att visa stavfel och misstag i dina texter ger Grammar.com dig relevanta förslag samt grammatikregler och e-bok för att förbättra ditt skrivande (allt gratis).
"Oavsett hur underbart ditt bibliotek är och hur intelligent dess design är, om du är den enda som förstår det, gör det ingen nytta. Dokumentation innebär inte bara autogenererade API-referenser, utan också kommenterade exempel och djupgående handledningar. Du behöver alla tre för att se till att ditt bibliotek lätt kan adopteras”, säger Nicholas Zakas, en välkänd frontendingenjör och bokförfattare. Det är därför vi idag bestämde oss för att ta en titt på några av de bästa och mest använda verktygen för mjukvarudokumentation och tekniskt skrivande.
GO TO FULL VERSION