Generelt er en teknisk skribents opgave en - at forberede en sådan tekst, der gør det muligt for en ny bruger at bruge programmet eller enheden korrekt.
En teknisk forfatter kan oprette forbindelse til en arbejdsgruppe i udviklingsfasen af et fremtidigt produkt. Produktet skal testes, funktioner og alle mulige funktioner skal undersøges. Resultatet af arbejdet er en komplet instruktion med en detaljeret beskrivelse af brugen af produktet ledsaget af klare illustrationer.
De vigtigste værktøjer til en teknisk forfatter er en teksteditor, en stemmeoptager samt, afhængigt af projektets detaljer, MS Manual of Style, Apple Style Manual, Chicago Manual of Style, MS Word, Adobe FrameMaker (til oprettelse af offline materiale), Adobe RoboHelp, MadCapFlare (til online dokumentation) og andre.
Kend dit arbejdsområde
Alle er meget opmærksomme på sætningen: "Hvis alt andet fejler, skal du endelig læse instruktionerne." Men hvordan kan du skrive instruktioner, så ønsket om at læse det opstår, før du begynder at arbejde med softwareproduktet? Hvordan gør du det informativt for både erfarne brugere og nybegyndere? Som teknisk forfatter skal du mestre følgende og lidt mere
- bestemme sammensætningen og strukturen af dokumenter, der er inkluderet i dokumentationssættet
- bestemme kravene til dokumentation og blive styret af dem i arbejdet
- effektivt præsentere indholdet af dokumenter
- udarbejde dokumentation i den krævede stil
- sikre dokumentationens relevans, spore dens ændringer.
Nogle it-virksomheder kræver, at en teknisk forfatter kender markup-sprog eller et af programmeringssprogene på niveau med kodelæsning, mens andre kræver færdigheder i at arbejde med databaser eller forespørgselsstyringssystemer.
Vis interesse og bliv engageret
Det, der helt sikkert vil være praktisk, er interessen for det område, du skriver om: Hvis en teknisk forfatter ikke er interesseret i det felt, hvor han arbejder, vil det være svært for ham. Et sådant erhverv er ikke egnet for dem, der ikke er klar til at forbedre deres sprogniveau - både indfødte og udenlandske. Hvis en person er interesseret i alt dette, finder han sig selv i dette erhverv.
Mester DITA
DITA-formatet viste sig generelt at være et meget praktisk værktøj til udvikling af teknisk dokumentation med sit specifikke indhold. For eksempel kan vi genbruge enhver tekstblok eller en hel sektion fra et dokument i et andet dokument. Og dette vil ikke være den sædvanlige "copy-paste", men brugen af en blok i forskellige dokumenter. Hvis der ændres noget i denne blok, er det nok for os at ændre teksten en gang - ændringen går automatisk til alle dokumenter. Vi kan også anvende filtre - skriv en universel sektion, indsæt den i flere dokumenter og filtrer derefter dens indhold afhængigt af dokumenttypen, kunden, systemet og andre parametre. Og vi tænker heller ikke på krydsreferencer mellem sektioner - det er nok at angive det rigtige sted nøglen til det afsnit, som vi vil henvise til. Når du samler et dokument, nummererer Toolkit selve sektionerne og laver smukke hyperlinks.
Korrektur: Det fungerer stadig
... også til professionel teknisk skrivning!
Når en forfatter er færdig med at arbejde på et dokument, skal han / hun indsende det til gennemgang. Forretningsanalytikere, udviklere, testere tjekker dokumentationen. Dette er en meget vigtig fase, fordi en forfatter altid kan begå en fejl - at misforstå noget, ikke at tage højde for nogle udokumenterede implementeringsfunktioner.
Tøv ikke med at bede om hjælp
Hvis du bare er nybegynder, eller teknisk skrivning er en del af dit universitetsprogram, eller hvis du ikke har tid nok til at afslutte dine tekniske lektier inden fristen, kan du overveje at delegere det til en professionel opgavehjælpstjeneste, såsom Min opgave lab. Først og fremmest er du bestemt ikke den første studerende, der har brug for eksperthjælp med at udføre tekniske lektieopgaver, og tjenester er fuldt klar til at give dig hjælp, selvom projektet er komplekst, og deadline er skræmmende tæt. Det er på tide at indrømme, at det er bedre at delegere end at mislykkes. Afgivelse af en teknisk skriftlig ordre tager ikke lang tid - du vil bare angive detaljerne i ordren, vedhæfte det ekstra materiale, angive kravene og fristen, vælge en betalingsmetode. Jo tidligere du bestiller, jo mindre betaler du. Uopsættelige ordrer er de dyreste. At bestille tekniske skrivestykker fra erfarne forfattere hjælper dig dog med at blive en bedre forfatter selv. Undersøg de modtagne materialer og brug dem som en prøve til yderligere opgaver.
Deltag i online TW-opgaver
Der er meget, du kan lære ved at konkurrere. IT-specialister har hackathons og andre konkurrencer. Tekniske skriveopgaver er ikke så populære for nu, men du kan finde en eller to i enhver sæson. Det er sjovt at deltage i sådanne begivenheder, og det hjælper også med at udvikle din unikke stil, lære af det bedste og det lyseste og finpudse dine færdigheder. Hovedideen er at forblive engageret og kreativ, at blive en del af det tekniske skrivemiljø.
Teknisk skrivning er en værdifuld del af oversættelsen fra et sprog til det samme sprog - fra teknisk sprog til brug af sprog. Det er et tilfredsstillende og interessant job, der kræver konstant læring, fokus, studere nye programmer og være en del af samfundet.
