At skrive softwaredokumentation spiller en integreret rolle i en programmørs arbejde. Som de siger, hvis det ikke er dokumenteret, så eksisterer det ikke, og i de fleste tilfælde er det lige så vigtigt at dokumentere din kode på en ordentlig måde som at skrive den. "Uanset hvor vidunderligt dit bibliotek er, og hvor intelligent dets design er, hvis du er den eneste, der forstår det, nytter det ikke noget. Dokumentation betyder ikke kun autogenererede API-referencer, men også kommenterede eksempler og dybdegående selvstudier. Du har brug for alle tre for at sikre, at dit bibliotek nemt kan adopteres,” sagde Nicholas Zakas, en velkendt frontend-ingeniør og bogforfatter. Derfor besluttede vi i dag at tage et kig på nogle af de bedste og mest brugte værktøjer til softwaredokumentation og teknisk skrivning.
Hjælp til forfatterværktøjer
Hjælpeværktøjer til forfatterskab spiller en stor rolle i softwaredokumentation og teknisk skrivning, da de gør det meget nemmere at designe, skrive, udgive og vedligeholde softwaredokumentation. De giver dig mulighed for at reducere den nødvendige tid og indsats, når du laver alle slags hjælpematerialer både til slutbrugere og andre programmører/medarbejdere.
MadCap Flare er et af de mest populære hjælpeværktøjer takket være dets rige udvalg af funktioner, der giver dig mulighed for at gøre meget mere end blot at skrive hjælpedokumentation. MadCap Flare er designet til avanceret emnebaseret forfatterskab, single-source publicering og indholdsstyring. Det giver dig mulighed for at oprette hjælpe- og kundesupportwebsteder, ofte stillede spørgsmål, vidensbaser, online læringscentre, vejledninger, politik- og proceduremanualer og mere. MadCap Flares funktioner gør det nemmere at genbruge det samme indhold i flere kanaler og udgive det hurtigt over en række platforme.
Document360 er en anden meget brugt webplatform, der giver dig mulighed for at opbygge, udgive og opdatere alle former for vidensbaser og hjælpematerialer. Det har også multi-profil funktionalitet, herunder en simpel Markdown-teksteditor, Category Manager til at opbygge vidensbasestrukturen, destinationssidetilpasningsfunktioner, versionsrulning, backup og gendannelse, fleksible roller og tilladelsesjusteringer og så videre.
Adobe RoboHelp er et andet kraftfuldt alternativt hjælpeværktøj, som tilbyder et lidt anderledes udvalg af funktioner sammenlignet med MadCap Flare og Document360. Især tilbyder Adobe RoboHelp nem udgivelse i flere formater, så du kan udgive indhold til en lang række populære outputformater, herunder Frameless Responsive HTML5, PDF, Microsoft Help (CHM) og endnu mindre almindelige formater som EPUB 3, KF8 og MOBI.
Help+Manuals største fordel er dens enkle grænseflade, som gør den meget tilgængelig og nem at bruge, sammen med fuld funktionalitet af en WYSIWYG XML-editor, multi-kanal publicering, fuld understøttelse af multimedier og komplekse modulære projekter, Webhelp-værktøj til problemfri integration af dokumentation til aktive hjemmesider og så videre.
ClickHelp giver også en ganske kraftfuld webplatform til softwaredokumentation i form af vidensbaser, ofte stillede spørgsmål, selvstudier og andre hjælpeformater. Understøtter flere formater såsom Word, HTML, RTF, CHM, ODT, CHM, HTML5 Web Hjælp, PDF, DOCX osv. Nogle af ClickHelps signaturfunktioner er patenteret fuldtekstsøgning, der gør det nemmere at finde specifikke emner eller artikler både for forfattere og brugere, samt et udvalg af flere præbyggede skabeloner til dokumentationsdesignet.
Skærmoptagelsesværktøjer
Det meste softwaredokumentation og hjælpemateriale skal inkludere skærmbilleder, så det ville give mening at lave en kort oversigt over de bedste skærmoptagelsesværktøjer derude.
Hvis du bruger Windows som dit operativsystem, kommer det med et klippeværktøj, som giver dig mulighed for at lave skærmbilleder af hele skærmen, separate vinduer eller en del af skærmen og bruge penneværktøjet til at fremhæve nogle specifikke dele af skærmbilledet.
FireShot er et populært browser-plugin, der understøtter stort set alle moderne browsere som Chrome, Firefox, Internet Explorer og Opera. Giver dig mulighed for at fange hele websiden eller en bestemt del af den.
SnagIt er et mere komplekst skærmoptagelsesværktøj. Det giver dig mulighed for at fange rulleområder på enhver side, samt understøtte videooptagelse. Du kan også bruge dette billede til at oprette GIF'er og optage specifikke sæt handlinger på skærmen.
Stave- og grammatikkontrol
Det er også vigtigt at sikre, at din dokumentation er skrevet korrekt uden grammatik og tegnsætningsfejl. Her er nogle af de værktøjer, der hjælper dig med at finde fejl i dine tekster og rette dem.
En af de mest populære gratis online stave- og grammatikkontrol. Skribenter kan identificere og rette over 250 forskellige typer fejl, herunder navneord, stedord, præpositioner, verber, homonymer, tegnsætning, typografi og så videre.
Som en tilføjelse til at vise stavefejl og fejl i dine tekster, giver Grammar.com dig relevante forslag samt grammatikregler og e-bog for at forbedre din skrivning (alt gratis).
"Uanset hvor vidunderligt dit bibliotek er, og hvor intelligent dets design er, hvis du er den eneste, der forstår det, nytter det ikke noget. Dokumentation betyder ikke kun autogenererede API-referencer, men også kommenterede eksempler og dybdegående selvstudier. Du har brug for alle tre for at sikre, at dit bibliotek nemt kan adopteres,” sagde Nicholas Zakas, en velkendt frontend-ingeniør og bogforfatter. Derfor besluttede vi i dag at tage et kig på nogle af de bedste og mest brugte værktøjer til softwaredokumentation og teknisk skrivning.
GO TO FULL VERSION