Å skrive programvaredokumentasjon spiller en integrert rolle i arbeidet til en programmerer. Som de sier, hvis den ikke er dokumentert, så eksisterer den ikke, og i de fleste tilfeller er det like viktig å dokumentere koden på en riktig måte som å faktisk skrive den. «Uansett hvor fantastisk biblioteket ditt er og hvor intelligent design det er, hvis du er den eneste som forstår det, hjelper det ikke. Dokumentasjon betyr ikke bare autogenererte API-referanser, men også kommenterte eksempler og dybdeveiledninger. Du trenger alle tre for å sikre at biblioteket ditt enkelt kan tas i bruk,” sa Nicholas Zakas, en velkjent frontend-ingeniør og bokforfatter. Det er derfor vi i dag bestemte oss for å ta en titt på noen av de beste og mest brukte verktøyene for programvaredokumentasjon og teknisk skriving.
Hjelp til å skrive verktøy
Hjelpe forfatterverktøy spiller en viktig rolle i programvaredokumentasjon og teknisk skriving, siden de gjør det mye enklere å designe, skrive, publisere og vedlikeholde programvaredokumentasjon. De lar deg redusere tid og krefter som trengs når du lager alle slags hjelpemateriell både for sluttbrukere og andre programmerere/ansatte.
MadCap Flare er et av de mest populære hjelpeskrivingsverktøyene takket være det rike utvalget av funksjoner som lar deg gjøre mye mer enn bare å skrive hjelpedokumentasjon. MadCap Flare ble designet for avansert emnebasert forfatterskap, enkeltkildepublisering og innholdsadministrasjon. Den lar deg lage hjelpe- og kundestøttenettsteder, vanlige spørsmål, kunnskapsbaser, online læringssentre, guider, retningslinjer og prosedyremanualer og mer. MadCap Flares funksjoner gjør det enklere å gjenbruke det samme innholdet i flere kanaler og publisere det raskt over en rekke plattformer.
Document360 er en annen mye brukt nettplattform som lar deg bygge, publisere og oppdatere alle slags kunnskapsbaser og hjelpemateriell. Den har også multi-profil funksjonalitet, inkludert en enkel Markdown-tekstredigerer, Category Manager for å bygge kunnskapsbasestrukturen, destinasjonssidetilpasningsfunksjoner, versjonsrulling, sikkerhetskopiering og gjenoppretting, fleksible roller og tillatelser justering, og så videre.
Adobe RoboHelp er et annet kraftig alternativt hjelpeskrivingsverktøy, som tilbyr et litt annerledes utvalg av funksjoner sammenlignet med MadCap Flare og Document360. Spesielt tilbyr Adobe RoboHelp enkel publisering i flere formater, slik at du kan publisere innhold til et bredt spekter av populære utdataformater, inkludert Frameless Responsive HTML5, PDF, Microsoft Help (CHM), og enda mindre vanlige formater som EPUB 3, KF8 og MOBI.
Help+Manuals største fordel er det enkle grensesnittet som gjør det svært tilgjengelig og lett å bruke, sammen med full funksjonalitet til en WYSIWYG XML-editor, flerkanalspublisering, full støtte for multimedia og komplekse modulære prosjekter, Webhelp-verktøy for sømløs integrasjon av dokumentasjon til aktive nettsider, og så videre.
ClickHelp gir også en ganske kraftig nettplattform for programvaredokumentasjon i form av kunnskapsbaser, vanlige spørsmål, veiledninger og andre hjelpeformater. Støtter flere formater som Word, HTML, RTF, CHM, ODT, CHM, HTML5 Web Help, PDF, DOCX osv. Noen av ClickHelps signaturfunksjoner er patentert fulltekstsøk som gjør det lettere å finne spesifikke emner eller artikler både for forfattere og brukere, samt et utvalg av flere forhåndsbygde maler for dokumentasjonsdesignet.
Skjermfangstverktøy
Det meste av programvaredokumentasjon og hjelpemateriell må inkludere skjermbilder, så det vil være fornuftig å lage en kort oversikt over de beste skjermopptaksverktøyene der ute.
Hvis du bruker Windows som operativsystem, kommer det med et klippeverktøy, som lar deg lage skjermbilder av hele skjermen, separate vinduer eller en del av skjermen, og bruke pennverktøyet til å markere noen spesifikke deler av skjermbildet.
FireShot er en populær nettleserplugin som støtter stort sett alle moderne nettlesere som Chrome, Firefox, Internet Explorer og Opera. Lar deg fange hele nettsiden eller en bestemt del av den.
SnagIt er et mer komplekst skjermopptaksverktøy. Den lar deg fange opp rulleområder på en hvilken som helst side, samt støtte videoopptak. Du kan også bruke dette bildet til å lage GIF-er og ta opp spesifikke sett med handlinger på skjermen.
Stave- og grammatikkkontroller
Det er også viktig å sørge for at dokumentasjonen er skrevet riktig uten grammatikk og tegnsettingsfeil. Her er noen av verktøyene som hjelper deg å finne feil i tekstene dine og fikse dem.
En av de mest populære gratis stave- og grammatikkkontrollene på nettet. Skrivere kan identifisere og korrigere over 250 forskjellige typer feil, inkludert substantiv, pronomen, preposisjoner, verb, homonymer, tegnsetting, typografi og så videre.
Som et tillegg til å vise skrivefeil og feil i tekstene dine, gir Grammar.com deg relevante forslag samt grammatikkregler og e-bok for å forbedre skrivingen din (alt gratis).
«Uansett hvor fantastisk biblioteket ditt er og hvor intelligent design det er, hvis du er den eneste som forstår det, hjelper det ikke. Dokumentasjon betyr ikke bare autogenererte API-referanser, men også kommenterte eksempler og dybdeveiledninger. Du trenger alle tre for å sikre at biblioteket ditt enkelt kan tas i bruk,” sa Nicholas Zakas, en velkjent frontend-ingeniør og bokforfatter. Det er derfor vi i dag bestemte oss for å ta en titt på noen av de beste og mest brukte verktøyene for programvaredokumentasjon og teknisk skriving.
GO TO FULL VERSION