Ka insenerid, teadlased ja meditsiinitöötajad peavad olema head kirjutajad ning tehnilised aruanded seda tõestavad! Hea tehniline aruanne esitab andmed ja analüüsi konkreetse teema kohta selgelt, hästi organiseeritud ja tõhusalt. Enne kirjutamise alustamist määrake oma sõnum ja sihtrühm ning tehke ülevaade. Seejärel kirjutage aruande põhiosa ja ümbritsege see vastavalt teie valitud paigutusele muude vajalike jaotistega.
1
Määrake sõnum, mida soovite aruande kaudu edastada. Olete oma uurimistööd teinud ja andmeid kogunud, nii et nüüd on aeg endalt küsida, mida see kõik tähendab. Kuidas määratlete käsitletavat probleemi või teemat ning milliseid järeldusi saate andmete ja tõendite põhjal teha? Näiteks võite soovida edastada sõnumi, et teatud keemilise ühendi ekstraheerimise uus meetod on nii ohutum kui ka kasulikum. kulutõhus.Parimad tehnilised aruanded jäävad kogu aeg selgeks ja keskendunuks, neil on konkreetne eesmärk ja need edastavad teavet loogilises järjekorras. Töötage nõustajate, juhendajate või kolleegidega, et täpsustada aruande sõnumit ja/või eesmärki. Need võivad olla väga erinevad, olenevalt sellest, kas aruanne on koostatud akadeemilistel, ärilistel või muudel eesmärkidel.
2
Enne kirjutamise alustamist määrake oma publik. Kes loeb teie aruandekaaslasi, ettevõtete juhte, üldsust või kedagi teist? On oluline, et teie aruanne oleks kirjutatud nii, et selle andmed ja tulemused oleksid sihtrühmale hõlpsasti arusaadavad. Kui teised teie valdkonna töötajad loevad aruannet, võib see olla “tehnilisem” keeleliselt ja üksikasjalikult. Paljudel juhtudel on tehnilised aruanded siiski mõeldud neile, kes ei kuulu teie konkreetsesse distsipliini. Kui jah, siis vähendage kõnepruuki mitteeksperdist lugejatele. Kaaluge mitteekspert sõbral teie aruannet kogu protsessi vältel üle vaadata, et anda teile tagasisidet selle kohta, kas see on juurdepääsetav laiale vaatajaskonnale.
3
Looge ülevaade, mida kirjutamise ajal jälgida. Tehnilised aruanded on tavaliselt väga struktureeritud, sageli selgelt märgistatud ja nummerdatud jaotistega. Seetõttu on üsna lihtne koostada ülevaade, mis identifitseerib aruande iga peamise elemendi. Määrake kindlaks, millised konkreetsed jaotised teie aruandes peavad või võivad olla. Mis tahes paigutusnõuete osas konsulteerige isiku või organisatsiooniga, kellele te aruande esitate.
4
Looge aruandele põhjalik, kuid keskendunud sissejuhatus. Tehnilise aruande sissejuhatuses kirjeldatakse peamist probleemi või probleemi paberaadressid ja seda, kuidas te seda aruandes käsitlete. See peaks lugejale näitama, miks käsitletav teema on oluline, ja selgelt paika panema aruande eesmärgid.Enamasti on sissejuhatus tõenäoliselt 1–3 lõiku pikk. Sissejuhatuse lõpus peaks selgelt olema kirjas, mida raport “teeb.” Seda võib teha otsese avalduse kaudu (“Käesolev aruanne analüüsib”) või küsimuste rea (mis võib mõnel juhul olla täpp- või nummerdatud), millele tuleb vastata.
5
Esitage järgmises jaotises taustteave ja/või kirjanduse ülevaade. Kohe pärast sissejuhatust süvenege käsitletava teema põhiolukordadesse, näiteks probleemi kiiresse ajalugu ja selle olulisust tänapäeval. Kui see on olnud teie valdkonnas pideva arutelu teemaks, võite tutvustada lugejatele olulisi näiteid selle teemaga seotud varasematest töödest. Sisuliselt tahate, et lugejad, kes võivad selle teemaga uued tutvuda, tunneksid, et neil on vähemalt algelised teadmised. mõistke seda pärast selle jaotise lugemist.
6
Seejärel esitage projekti selge ja üksikasjalik kirjeldus. Selles jaotises räägite oma lugejale põhimõtteliselt sellest, mida te tegelikult probleemi või probleemi lahendamiseks tegite. Rääkige neile, mis tüüpi testimise või analüüsi te tegite, milliseid meetodeid ja seadmeid kasutades ning mis tahes muid asjakohaseid üksikasju. Kui teie aruanne keskendub näiteks konkreetsele katsele, öelge üksikasjalikult, kuidas see väljamõeldi, seadistati ja Seda nimetatakse mõnikord “meetodite” jaotiseks, kuna kirjeldate oma uurimistöö läbiviimiseks kasutatud meetodeid.
7
Esitage oma andmed ja kirjeldage järgmistes jaotistes, mida see kõik tähendab. Olete nüüd jõudnud tehnilise aruande keskmesse, milles olete kogutud andmed selgelt paika pannud ja kontekstualiseerinud. Enamikul juhtudel peate tegelike andmete esitamiseks esitama arvukalt jooniseid ja tabeleid. Ärge toetuge ainult neile, vaid kasutage teksti, et asetada tulemused teie sihtrühmale sobivasse konteksti. Võib olla raske kindlaks teha, kui palju andmeid esitada. Liiga vähe andmine võib teie analüüsi ja üldist aruannet oluliselt nõrgendada. Liiga palju andmine võib aga lugeja tabelite ja jooniste merre uputada. Esitage kindlasti kõik olulised andmed ja eksite, kui esitate liiga palju, kui pole teisiti juhitud. Esitage oma andmed loogilises järjekorras, nii et iga tabel või joonis viiks järgmisesse.
8
Lõpetage aruanne järeldusega, mis lõpetab teie sissejuhatuse. Tehnilises aruandes peaks teie sissejuhatus tõstatama “suured” küsimused ja teie järeldus peaks andma teie vastused. Kui näiteks loetlesite sissejuhatuses mitu konkreetset küsimust, vastake neile konkreetselt kokkuvõttes. Vastasel juhul kasutage seda tõmbamiseks. koondage oma leiud selgeks ja veenvaks väiteks. Olge oma järeldustes nii julge, kui teie andmed ja analüüs lubavad. Ärge kasutage selliseid mõisteid nagu “võib”, “võib-olla”, “võib”, ja nii kirjutage midagi sellist nagu “Andmed näitavad, et” Kuid ärge tehke järeldusi, mida teie andmed ei toeta.
9
Küsige oma ülikoolilt, tööandjalt jne konkreetseid juhiseid. Kuigi tehniliste aruannete korraldamine on üsna standarditud, võib konkreetne paigutus distsipliini või muude tegurite lõikes mõnevõrra erineda. Näiteks järgmine paigutus on üsna standardne, mida võiks teie konkreetsel juhul kasutada: TiitellehtAbstractKokkuvõteSisukord Jooniste loetelu / Tabelite loendPõhiaruanne: Sissejuhatus; Taust / Kirjanduse ülevaade; Projekti kirjeldus; Andmed / Andmete kirjeldus; Kokkuvõte TänuavaldusedViitedLisad
10
Looge oma aruande alguses lihtne tiitelleht. Tiitellehel peab ilmselgelt olema aruande pealkiri ja teie nimi ning see sisaldab sageli üksikasju, nagu aruande esitamise kuupäev ja eesmärk. Kontrollige oma eriala, osakonna, tööandja jne tiitellehe paigutusjuhiseid. Tüüpilise tiitellehe (ja üldise aruande paigutuse) leiate aadressilt https://my.mech.utah.edu/~rusmeeha/references/Writing.pdf
11
Andke aruandest lühiülevaade abstraktselt. Tehnilise aruande kokkuvõtte eesmärk on koondada aruande põhiosa umbes 300 sõnaks. Peate esitama väga kiire ülevaate sellest, mida aruanne hõlmab ja mis tahes järeldused või soovitused, mida selles teete. Kirjutage kokkuvõte pärast tegeliku aruande kirjutamist. Soovite, et see oleks lühendatud kirjeldus sellest, mida olete kirjutanud, mitte selle, mida kavatsete kirjutada. Kontrollige, kas teie kokkuvõtte jaoks on konkreetne sõnalimiit. Isegi kui seda pole, on 300 sõna hea sõnalimiit, mille poole püüdleda.
12
Looge kokkuvõte, mis koondab aruande umbes 90% võrra. Kommentaaride kokkuvõtted on saanud oma nime tänu sellele, et need on suunatud kõrgetele juhtidele, kellel ei ole tõenäoliselt aega kogu aruannet lugeda. Juhtaruanne peaks olema pikem ja üksikasjalikum kui abstraktne, kuid siiski moodustama ainult umbes 10% põhiaruande pikkusest. Kokkuvõte peaks keskenduma teie leidudele, järeldustele ja/või soovitustele ning võimaldama aruandes endas andmeid esitada, kuigi tuleks esitada andmete esiletõstmised. Olenevalt olukorrast peate võib-olla kirjutama kokkuvõtte, kokkuvõtte, või mõlemad.
13
Koostage sisukord, tabelite loend ja jooniste loend. Sisukord peaks jaotama kogu aruande jaotiste kaupa, et lugejad saaksid kiiresti kogu aruande aimu saada ja konkreetse jaotise üles leida. Tehnilised aruanded on andmepõhised ja sisaldavad alati palju tabeleid ja jooniseid, nii et esitage kõigi nende kohta loendid, mis need kiiresti tuvastavad ja annavad lugejatele teada, kust need leida. Kontrollige, kas nende jaotiste jaoks on vormindusjuhised. Kui vorming on teie otsustada, hoidke asjad lihtsad ja arusaadavad.
14
Järgige aruande põhiosa koos tänuavalduste jaotisega. Kui raamatute või muud tüüpi uurimistööde tunnustuste rubriigid tänavad sageli sõpru ja perekonda, siis tehnilistes aruannetes keskendutakse tavaliselt nende mainimisele, kes aitasid otseselt aruande koostamist hõlbustada. Põhimõtteliselt tuleks selles jaotises tunnustada kõiki üksikisikuid või rühmitusi, kes on teie tööd ametialaselt toetanud (sealhulgas rahaliselt, näiteks toetuste kaudu). See jaotis koosneb tavaliselt 1–2 lõigust ja järgib üsna lihtsat lauset “Autor soovib aitäh-vormingus.
15
Kaasake tsitaadid viidete sektsiooni, kasutades ühtset vormingut. Looge tsitaat iga allika kohta, mida aruande põhiosas tsiteerite või millele viitate. Kui teile ei anta konkreetset tsitaadivormingut, mida järgida (nt APA või MLA vorming), valige üks ja järgige seda järjepidevalt kogu selles jaotises ja kogu aruandes. Mõnel juhul võidakse teilt oodata ka teoste loendi esitamist. olete konsulteerinud, kuid pole töös konkreetselt viidanud. Kui te pole kindel, pöörduge vastava osakonna, organisatsiooni, üksikisiku vms poole.
16
Kasutage lisasid, et anda kasulikku, kuid mitte hädavajalikku teavet. Kui teil on näiteks palju algandmeid, mis iseenesest ei ole aruande jaoks olulised, kuid mis on siiski valgustavad, lisage need ühte või mitmesse lisasse. Ärge kunagi pange lisasse midagi, mida peate aruande jaoks oluliseks, leidke sellele koht töö põhiosas. Kasutage lisade loomisel ühtset ja hõlpsasti navigeeritavat vormingut. Need ei ole mõeldud juhuslike andme- või teabejuppide jaoks.